Function reference • epair

All functions

add.variables(): Add variables to a query

clear.all.cached(): Removes all cached memory of perform.call

clear.cached(): Removes memory of cached perform.call data for specific parameters

create.authentication(): Generate the string authentication needed for EPA API

create.base.call(): Make the first call when forming a query.

endpoints: Endpoints available in the EPA API

get.transpose(): Transpose a data frame

get_all_mas(): Get Monitoring Agencies.

get_all_pqaos(): Get Primary Quality Assurance Organizations.

get_annual_summary_in_bbox(): Get annual summary data in a bounding box (lat, long).

get_annual_summary_in_cbsa(): Get annual summary data in a Core Based Statistical Area.

get_annual_summary_in_county(): Get annual summary data in a county.

get_annual_summary_in_site(): Get annual summary data at a measurement site.

get_annual_summary_in_state(): Get annual summary data in a state.

get_aqs_key(): Get an API key from the AQS API.

get_cbsas(): Get all Core Based Statistical Areas.

get_counties_in_state(): Get all counties within a state.

get_daily_summary_in_bbox(): Returns daily summary data given a bounding box (lat, long).

get_daily_summary_in_cbsa(): Get daily summary data in a Core Based Statistical Area.

get_daily_summary_in_county(): Returns data summarized by day at the county level.

get_daily_summary_in_site(): Returns data summarized by day at measurement site level.

get_daily_summary_in_state(): Returns daily data at the state level.

get_fields_by_service(): Get fields required per service.

get_known_issues(): Get any known issues within the API.

get_monitors_in_bbox(): Get all monitoring sites within a bounding box (lat, long).

get_monitors_in_cbsa(): Get monitors within a Core Based Statistical Area.

get_monitors_in_county(): Get all monitors in a county.

get_monitors_in_site(): Get all monitors at a site.

get_monitors_in_state(): Get monitors in state.

get_parameter_classes(): Get all types of parameters.

get_parameters_in_class(): Get all parameters available within a particular parameter class.

get_qa_ape_in_agency(): Get quality assurance annual performance evaluations for a monitoring agency.

get_qa_ape_in_county(): Get quality assurance annual performance evaluations in a county.

get_qa_ape_in_pqao(): Get quality assurance annual performance evaluations for a primary quality assurance organization.

get_qa_ape_in_site(): Get quality assurance annual performance evaluations at a site.

get_qa_ape_in_state(): Get quality assurance annual performance evaluations in a state.

get_qa_blanks_in_agency(): Get quality assurance blank data for a monitoring agency.

get_qa_blanks_in_county(): Get quality assurance blank data in a county.

get_qa_blanks_in_pqao(): Get quality assurance blank data for a primary quality assurance organization.

get_qa_blanks_in_site(): Get quality assurance blank data at a site.

get_qa_blanks_in_state(): Get quality assurance blank data in a state.

get_qa_ca_in_agency(): Get quality assurance collocated assessment data for a monitoring agency.

get_qa_ca_in_county(): Get quality assurance collocated assessment data in a county.

get_qa_ca_in_pqao(): Get quality assurance collocated assessment data for a primary quality assurance organization.

get_qa_ca_in_site(): Get quality assurance collocated assessment data at a site.

get_qa_ca_in_state(): Get quality assurance collocated assessment data in a state.

get_qa_fra_in_agency(): Get quality assurance flow rate audit data for a monitoring agency.

get_qa_fra_in_county(): Get quality assurance flow rate audit data in a county.

get_qa_fra_in_pqao(): Get quality assurance flow rate audit data for a primary quality assurance organization.

get_qa_fra_in_site(): Get quality assurance flow rate audit data at a site.

get_qa_fra_in_state(): Get quality assurance flow rate audit data in a state.

get_qa_frv_in_agency(): Get quality assurance flow rate verification data for a monitoring agency.

get_qa_frv_in_county(): Get quality assurance flow rate verification data in a county.

get_qa_frv_in_pqao(): Get quality assurance flow rate verification data for a primary quality assurance organization.

get_qa_frv_in_site(): Get quality assurance flow rate verification data at a site.

get_qa_frv_in_state(): Get quality assurance flow rate verification data in a state.

get_qa_pep_in_agency(): Get quality assurance PEP audit data for a monitoring agency.

get_qa_pep_in_county(): Get quality assurance PEP audit data in a county.

get_qa_pep_in_pqao(): Get quality assurance PEP audit data for a primary quality assurance organization.

get_qa_pep_in_site(): Get quality assurance PEP audit data at a site.

get_qa_pep_in_state(): Get quality assurance PEP audit data in a state.

get_qa_qc_in_agency(): Get quality assurance one point quality control data for a monitoring agency.

get_qa_qc_in_county(): Get quality assurance annual one point quality control data in a county.

get_qa_qc_in_pqao(): Get quality assurance one point quality control data for a primary quality assurance organization.

get_qa_qc_in_site(): Get quality assurance one point quality control data at a site.

get_qa_qc_in_state(): Get quality assurance one point quality control data in a state.

get_quarterly_summary_in_bbox(): Get quarterly summary data in a bounding box (lat, long).

get_quarterly_summary_in_cbsa(): Get quarterly summary data in a Core Based Statistical Area.

get_quarterly_summary_in_county(): Get quarterly summary data in a county.

get_quarterly_summary_in_site(): Returns data summaries by yearly quarter.

get_quarterly_summary_in_state(): Get quarterly summary data in a state.

get_revision_history(): Get the API's revision history.

get_samples_in_bbox(): Get samples (finest grained data) for a bounding box (lat, long).

get_samples_in_cbsa(): Get samples (finest grained data) for a Core Based Statistical Area.

get_samples_in_county(): Get samples (finest grained data) for a county.

get_samples_in_site(): Get samples (finest grained data) for a measurement site.

get_samples_in_state(): Get samples (finest grained data) for a state.

get_sites_in_county(): Get all measurement sites within a county.

get_state_fips(): Get all FIPS codes for each US state.

get_tf_qa_ape_in_agency(): Get quality assurance annual performance evaluations for a monitoring agency in transaction format.

get_tf_qa_ape_in_county(): Get quality assurance annual performance evaluations in a county in transaction format.

get_tf_qa_ape_in_pqao(): Get quality assurance annual performance evaluations for a primary quality assurance organization in transaction format.

get_tf_qa_ape_in_site(): Get quality assurance annual performance evaluations at a site in transaction format.

get_tf_qa_ape_in_state(): Get quality assurance annual performance evaluations in a state in transaction format.

get_tf_sample_in_agency(): Get sample data in the transaction format for a monitoring agency.

get_tf_sample_in_county(): Get sample data in the transaction format in a county.

get_tf_sample_in_site(): Get sample data in the transaction format at a site.

get_tf_sample_in_state(): Get sample data in the transaction format in a state.

is_API_running(): Check if the API is up and running

list.cached.data(): Shows contents of cache directory

list.remove.escapes.spaces(): Remove tabs, new lines, and empty spaces from entries in a list

list.string.replacer(): Replace every string entry in a list

lookup_by_bbox(): Internal function to perform geospatial lookup by bounding box (lat, long).

lookup_by_cbsa(): Internal function to perform geospatial lookup by Core Based Statistical Area.

lookup_by_county(): Internal function to perform geospatial lookup by county.

lookup_by_ma(): Internal function to perform geospatial lookup by monitoring agency.

lookup_by_pqao(): Internal function to perform geospatial lookup by primary quality assurance organization.

lookup_by_site(): Internal function to perform geospatial lookup by site.

lookup_by_state(): Internal function to perform geospatial lookup by state.

non.cached.perform.call(): Perform call and convert data into list

perform.call(): Cached version of the perform.call function

perform.call.raw(): Perform call and keep original result

place.call(): Place the URL as a call to the EPA API

place.call.raw(): Perform call and maintain JSON Lite structure

remove.escapes.spaces(): Remove tabs, new lines, and empty spaces from entries in a data frame

retrieve.cached.call(): Retrieves memory of previously cached call.

save.new.cached.call(): Saves a new call that has not been previously cached yet.

service.names: Names of services offered by the EPA API

services: Services offered by the EPA API

string.replacer(): Replace all characters entries in data frame

variable.types: Variable parameter names to use

variables: Variables used for querying in EPA API