Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace links, clean up #32

Merged
merged 2 commits into from
Jul 23, 2022
Merged

Replace links, clean up #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
708f19d
Replace links, clean up
GLOrozcoM Jul 21, 2022
f2501fb
Add NEWS.md file
GLOrozcoM Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 0 additions & 45 deletions .github/CODE_OF_CONDUCT.md
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: epair
Title: EPA Data Helper for R
Version: 0.1.0
Version: 1.0.0
Authors@R:
c(person(given = "G.L.",
family = "Orozco-Mulfinger",
Expand Down Expand Up @@ -32,8 +32,8 @@ Suggests:
knitr (>= 1.33),
rmarkdown (>= 2.8),
testthat (>= 3.0.2)
BugReports: https://github.com/GLOrozcoM/epair/issues
URL: https://github.com/GLOrozcoM/epair
BugReports: https://github.com/ropensci/epair/issues
URL: https://github.com/ropensci/epair
VignetteBuilder:
knitr
SystemRequirements: pandoc
40 changes: 40 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
epair 1.0.0 (2022-07-22)
=========================

Released to `rOpenSci`.

### NEW FEATURES

* Wrapper functions for all services available from the Environmental Protection Agency (EPA) Air Quality API.
* Caching for previously made requests.
* Comprehensive testing with mocks using `httptest`.
* CI/CD for automatic pull request checks including test coverage and R-CMD-check.

### MINOR IMPROVEMENTS

* Authentication using `.Renviron`.
* Typo's and formatting for code.
* Function to get an API key from within `epair`.
* Change `print()` to `message()` for expected error types.
* Redact mock directory paths to be less than 100 bytes for portability.
* Documentation mismatches fixed.
* A contributing file.

### BUG FIXES

* Failing tests and installation in Windows and Ubuntu.
* Problem with `name` argument in `add.variables()`.

### DEPRECATED OR DEFUNCT

* Removed scraping logic used to make loaded data structures.

epair 0.1.0 (2020-12-07)
=========================

### NEW FEATURES

* Loaded in variables to search for and query endpoint and variables in the original Environmental Protection Agency Air Quality API.
* General purpose API calling functions with specified variables and endpoints for services.
* Simple test suites using `testthat`.
* Simple scraping logic to make service and variable data structures.
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!-- badges: start -->
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4309792.svg)](https://doi.org/10.5281/zenodo.4309792)
[![R-CMD-check](https://github.com/GLOrozcoM/epair/workflows/R-CMD-check/badge.svg)](https://github.com/GLOrozcoM/epair/actions)
[![R-CMD-check](https://github.com/ropensci/epair/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/epair/actions)
<!-- badges: end -->

A package designed to aid in getting data from the Environmental Protection Agency (EPA) API at
Expand All @@ -11,23 +11,29 @@ https://aqs.epa.gov/aqsweb/documents/data_api.html.
### Overview

The `epair` package helps you determine what data you want and how to get that data from the EPA API.
It provides loaded in variables that help you navigate services in the API, and a simple way to query the data. A comprehensive site for using `epair` can be found at https://glorozcom.github.io/epair/.
It provides loaded in variables that help you navigate services in the API, and a simple way to query the data.

Broadly, you can explore possible calls by typing `epair::get_` and seeing what autocomplete offers in R.
Most of these functions require a start and end date along with a geographical boundary type (like CBSA code or bounding box). For more details, we recommend looking at the help docs `?epair::get_[type]()` for the function you're interested in using to see the exact required params.

### Installation

You can download the latest release from this repo using `devtools`.
You can download the package simply by using `r-universe`.

```
devtools::install.github("GLOrozcoM/epair")
install.packages("epair", repos = "https://ropensci.r-universe.dev")
````

Alternativately, you can download the latest release from this repo using `devtools`.

```
devtools::install.github("ropensci/epair")
```

Or, download these files and in your working directory run
Or, download these files, and in your working directory run the following.

```
devtools::install("GLOrozcoM/epair")
devtools::install("ropensci/epair")
```

`epair` depends on `httr` for making its data calls and `rvest` for creating the variables loaded in with the package. We recommend having `httr` installed (automatically taken care of through package dependencies), and only installing `rvest` if you're curious about how package variables were made.
Expand Down