Package: epair 1.1.0

G.L. Orozco-Mulfinger

epair: EPA Data Helper for R

Aid the user in making queries to the EPA API site found at https://aqs.epa.gov/aqsweb/documents/data_api. This package combines API calling methods from various web scraping packages with specific strings to retrieve data from the EPA API. It also contains easy to use loaded variables that help a user navigate services offered by the API and aid the user in determining the appropriate way to make a an API call.

Authors:G.L. Orozco-Mulfinger [aut, cre], Madyline Lawrence [aut], Owais Gilani [aut]

epair_1.1.0.tar.gz
epair_1.1.0.zip(r-4.7)epair_1.1.0.zip(r-4.6)epair_1.1.0.zip(r-4.5)
epair_1.1.0.tgz(r-4.6-any)epair_1.1.0.tgz(r-4.5-any)
epair_1.1.0.tar.gz(r-4.7-any)epair_1.1.0.tar.gz(r-4.6-any)
epair_1.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
epair/json (API)

# Install 'epair' in R:
install.packages('epair', repos = c('https://packages.ropensci.org', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #418

Bug tracker:https://github.com/ropensci/epair/issues

Pkgdown/docs site:https://docs.ropensci.org

Datasets:

On CRAN:

Conda:

5.23 score 8 stars 14 scripts 77 exports 21 dependencies

Last updated from:e8f1f1d4ba (on master). Checks:10 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK125
pkgdown docsOK682
source / vignettesOK203
linux-release-x86_64OK134
macos-release-arm64OK91
macos-oldrel-arm64OK91
windows-develOK80
windows-releaseOK79
windows-oldrelOK125
wasm-releaseOK109

Exports:add.variablesclear.all.cachedclear.cachedcreate.authenticationget_all_masget_all_pqaosget_aqs_keyget_cbsasget_counties_in_stateget_daily_summary_in_bboxget_daily_summary_in_cbsaget_daily_summary_in_countyget_daily_summary_in_siteget_daily_summary_in_stateget_fields_by_serviceget_known_issuesget_monitors_in_bboxget_monitors_in_cbsaget_monitors_in_countyget_monitors_in_siteget_monitors_in_stateget_parameter_classesget_parameters_in_classget_qa_ape_in_agencyget_qa_ape_in_countyget_qa_ape_in_pqaoget_qa_ape_in_siteget_qa_ape_in_stateget_qa_blanks_in_agencyget_qa_blanks_in_countyget_qa_blanks_in_pqaoget_qa_blanks_in_siteget_qa_blanks_in_stateget_qa_ca_in_agencyget_qa_ca_in_countyget_qa_ca_in_pqaoget_qa_ca_in_siteget_qa_ca_in_stateget_qa_fra_in_agencyget_qa_fra_in_countyget_qa_fra_in_pqaoget_qa_fra_in_siteget_qa_fra_in_stateget_qa_frv_in_agencyget_qa_frv_in_countyget_qa_frv_in_pqaoget_qa_frv_in_siteget_qa_frv_in_stateget_qa_pep_in_agencyget_qa_pep_in_countyget_qa_pep_in_pqaoget_qa_pep_in_siteget_qa_pep_in_stateget_qa_qc_in_agencyget_qa_qc_in_countyget_qa_qc_in_pqaoget_qa_qc_in_siteget_qa_qc_in_stateget_revision_historyget_sites_in_countyget_state_fipsget_tf_qa_ape_in_agencyget_tf_qa_ape_in_countyget_tf_qa_ape_in_pqaoget_tf_qa_ape_in_siteget_tf_qa_ape_in_stateget_tf_sample_in_agencyget_tf_sample_in_countyget_tf_sample_in_siteget_tf_sample_in_stateis_API_runninglist.cached.datanon.cached.perform.callperform.callperform.call.rawretrieve.cached.callsave.new.cached.call

Dependencies:askpassclicurldigestgluehttrjsonlitelifecyclemagrittrmimeopensslR.cacheR.methodsS3R.ooR.utilsR6rlangstringistringrsysvctrs

Make a more complex call
Option 1: User friendly functions | Adding a single variable | Adding multiple variables | Option 2: Manually placing the call | Caching a call
Rendered froma06_make-a-more-complex-call.Rmdusingknitr::rmarkdown

Last update: 2022-06-01
Started: 2021-11-28

Making your first call
See what services the API offers | A basic call | Setup | Option 1: User friendly functions | Option 2: Manually placing the call
Rendered froma05_making-your-first-call.Rmdusingknitr::rmarkdown

Last update: 2022-06-01
Started: 2021-11-28

Summary
Option 1: User friendly functions | Option 2: Manually placing the call
Rendered froma07_wrap-up.Rmdusingknitr::rmarkdown

Last update: 2022-06-01
Started: 2021-11-28

Clarification on terminology
Terms | Code and functions | Variables and objects | Parameter codes
Rendered froma02_ClarificationTerm.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

Finding endpoints
Simple listing | Using the services object
Rendered froma08_Endpoints.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

Installation
How to install and load epair | Directly from GitHub | After downloading package files
Rendered froma03_Installation.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

Navigating API Services
The services object | What service to use | Filters | Further information
Rendered froma09_Services.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

Setup
Authentication setup | Checking if the API is running
Rendered froma04_setup.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

The Anatomy of an EPA API request
Rendered froma01_ananomyEPARequest.Rmdusingknitr::rmarkdown

Last update: 2021-11-28
Started: 2021-11-28

epair
Rendered fromepair.Rmdusingknitr::rmarkdown

Last update: 2021-10-23
Started: 2021-07-17

Readme and manuals

Help Manual

Help pageTopics
Add variables to a queryadd.variables
Removes all cached memory of perform.callclear.all.cached
Removes memory of cached perform.call data for specific parametersclear.cached
Generate the string authentication needed for EPA APIcreate.authentication
Make the first call when forming a query.create.base.call
Endpoints available in the EPA APIendpoints
Get Monitoring Agencies.get_all_mas
Get Primary Quality Assurance Organizations.get_all_pqaos
Get annual summary data in a bounding box (lat, long).get_annual_summary_in_bbox
Get annual summary data in a Core Based Statistical Area.get_annual_summary_in_cbsa
Get annual summary data in a county.get_annual_summary_in_county
Get annual summary data at a measurement site.get_annual_summary_in_site
Get annual summary data in a state.get_annual_summary_in_state
Get an API key from the AQS API.get_aqs_key
Get all Core Based Statistical Areas.get_cbsas
Get all counties within a state.get_counties_in_state
Returns daily summary data given a bounding box (lat, long).get_daily_summary_in_bbox
Get daily summary data in a Core Based Statistical Area.get_daily_summary_in_cbsa
Returns data summarized by day at the county level.get_daily_summary_in_county
Returns data summarized by day at measurement site level.get_daily_summary_in_site
Returns daily data at the state level.get_daily_summary_in_state
Get fields required per service.get_fields_by_service
Get any known issues within the API.get_known_issues
Get all monitoring sites within a bounding box (lat, long).get_monitors_in_bbox
Get monitors within a Core Based Statistical Area.get_monitors_in_cbsa
Get all monitors in a county.get_monitors_in_county
Get all monitors at a site.get_monitors_in_site
Get monitors in state.get_monitors_in_state
Get all types of parameters.get_parameter_classes
Get all parameters available within a particular parameter class.get_parameters_in_class
Get quality assurance annual performance evaluations for a monitoring agency.get_qa_ape_in_agency
Get quality assurance annual performance evaluations in a county.get_qa_ape_in_county
Get quality assurance annual performance evaluations for a primary quality assurance organization.get_qa_ape_in_pqao
Get quality assurance annual performance evaluations at a site.get_qa_ape_in_site
Get quality assurance annual performance evaluations in a state.get_qa_ape_in_state
Get quality assurance blank data for a monitoring agency.get_qa_blanks_in_agency
Get quality assurance blank data in a county.get_qa_blanks_in_county
Get quality assurance blank data for a primary quality assurance organization.get_qa_blanks_in_pqao
Get quality assurance blank data at a site.get_qa_blanks_in_site
Get quality assurance blank data in a state.get_qa_blanks_in_state
Get quality assurance collocated assessment data for a monitoring agency.get_qa_ca_in_agency
Get quality assurance collocated assessment data in a county.get_qa_ca_in_county
Get quality assurance collocated assessment data for a primary quality assurance organization.get_qa_ca_in_pqao
Get quality assurance collocated assessment data at a site.get_qa_ca_in_site
Get quality assurance collocated assessment data in a state.get_qa_ca_in_state
Get quality assurance flow rate audit data for a monitoring agency.get_qa_fra_in_agency
Get quality assurance flow rate audit data in a county.get_qa_fra_in_county
Get quality assurance flow rate audit data for a primary quality assurance organization.get_qa_fra_in_pqao
Get quality assurance flow rate audit data at a site.get_qa_fra_in_site
Get quality assurance flow rate audit data in a state.get_qa_fra_in_state
Get quality assurance flow rate verification data for a monitoring agency.get_qa_frv_in_agency
Get quality assurance flow rate verification data in a county.get_qa_frv_in_county
Get quality assurance flow rate verification data for a primary quality assurance organization.get_qa_frv_in_pqao
Get quality assurance flow rate verification data at a site.get_qa_frv_in_site
Get quality assurance flow rate verification data in a state.get_qa_frv_in_state
Get quality assurance PEP audit data for a monitoring agency.get_qa_pep_in_agency
Get quality assurance PEP audit data in a county.get_qa_pep_in_county
Get quality assurance PEP audit data for a primary quality assurance organization.get_qa_pep_in_pqao
Get quality assurance PEP audit data at a site.get_qa_pep_in_site
Get quality assurance PEP audit data in a state.get_qa_pep_in_state
Get quality assurance one point quality control data for a monitoring agency.get_qa_qc_in_agency
Get quality assurance annual one point quality control data in a county.get_qa_qc_in_county
Get quality assurance one point quality control data for a primary quality assurance organization.get_qa_qc_in_pqao
Get quality assurance one point quality control data at a site.get_qa_qc_in_site
Get quality assurance one point quality control data in a state.get_qa_qc_in_state
Get quarterly summary data in a bounding box (lat, long).get_quarterly_summary_in_bbox
Get quarterly summary data in a Core Based Statistical Area.get_quarterly_summary_in_cbsa
Get quarterly summary data in a county.get_quarterly_summary_in_county
Returns data summaries by yearly quarter.get_quarterly_summary_in_site
Get quarterly summary data in a state.get_quarterly_summary_in_state
Get the API's revision history.get_revision_history
Get samples (finest grained data) for a bounding box (lat, long).get_samples_in_bbox
Get samples (finest grained data) for a Core Based Statistical Area.get_samples_in_cbsa
Get samples (finest grained data) for a county.get_samples_in_county
Get samples (finest grained data) for a measurement site.get_samples_in_site
Get samples (finest grained data) for a state.get_samples_in_state
Get all measurement sites within a county.get_sites_in_county
Get all FIPS codes for each US state.get_state_fips
Get quality assurance annual performance evaluations for a monitoring agency in transaction format.get_tf_qa_ape_in_agency
Get quality assurance annual performance evaluations in a county in transaction format.get_tf_qa_ape_in_county
Get quality assurance annual performance evaluations for a primary quality assurance organization in transaction format.get_tf_qa_ape_in_pqao
Get quality assurance annual performance evaluations at a site in transaction format.get_tf_qa_ape_in_site
Get quality assurance annual performance evaluations in a state in transaction format.get_tf_qa_ape_in_state
Get sample data in the transaction format for a monitoring agency.get_tf_sample_in_agency
Get sample data in the transaction format in a county.get_tf_sample_in_county
Get sample data in the transaction format at a site.get_tf_sample_in_site
Get sample data in the transaction format in a state.get_tf_sample_in_state
Transpose a data frameget.transpose
Check if the API is up and runningis_API_running
Shows contents of cache directorylist.cached.data
Remove tabs, new lines, and empty spaces from entries in a listlist.remove.escapes.spaces
Replace every string entry in a listlist.string.replacer
Internal function to perform geospatial lookup by bounding box (lat, long).lookup_by_bbox
Internal function to perform geospatial lookup by Core Based Statistical Area.lookup_by_cbsa
Internal function to perform geospatial lookup by county.lookup_by_county
Internal function to perform geospatial lookup by monitoring agency.lookup_by_ma
Internal function to perform geospatial lookup by primary quality assurance organization.lookup_by_pqao
Internal function to perform geospatial lookup by site.lookup_by_site
Internal function to perform geospatial lookup by state.lookup_by_state
Perform call and convert data into listnon.cached.perform.call
Cached version of the perform.call functionperform.call
Perform call and keep original resultperform.call.raw
Place the URL as a call to the EPA APIplace.call
Perform call and maintain JSON Lite structureplace.call.raw
Remove tabs, new lines, and empty spaces from entries in a data frameremove.escapes.spaces
Retrieves memory of previously cached call.retrieve.cached.call
Saves a new call that has not been previously cached yet.save.new.cached.call
Names of services offered by the EPA APIservice.names
Services offered by the EPA APIservices
Replace all characters entries in data framestring.replacer
Variable parameter names to usevariable.types
Variables used for querying in EPA APIvariables