aqs_transactionsample_by_site {RAQSAPI}

aqs_transactionsample_by_site

Description

Returns transactionsample data aggregated by site in the AQS Submission Transaction Format (RD) sample (raw) data for a parameter code aggregated by matching input parameter, sitenum, countycode and stateFIPS provided for bdate - edate time frame. Includes data both in submitted and standard units

Usage

aqs_transactionsample_by_site(
  parameter,
  bdate,
  edate,
  stateFIPS,
  countycode,
  sitenum,
  cbdate = NA_Date_,
  cedate = NA_Date_,
  return_header = FALSE
)

Arguments

parameter

a character list or a single character string which represents the parameter code of the air pollutant related to the data being requested.

bdate

a R date object which represents that begin date of the data selection. Only data on or after this date will be returned.

edate

a R date object which represents that end date of the data selection. Only data on or before this date will be returned.

stateFIPS

a R character object which represents the 2 digit state FIPS code (with leading zero) for the state being requested. @seealso aqs_states() for the list of available FIPS codes.

countycode

a R character object which represents the 3 digit state FIPS code for the county being requested (with leading zero(s)). @seealso aqs_counties_by_state() for the list of available county codes for each state.

sitenum

a R character object which represents the 4 digit site number (with leading zeros) within the county and state being requested.

cbdate

a R date object which represents a "beginning date of last change" that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to NA_Date_.

cedate

a R date object which represents an "end date of last change" that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to NA_Date_.

return_header

If FALSE (default) only returns data requested. If TRUE returns a AQSAPI_v2 object which is a two item list that contains header information returned from the API server mostly used for debugging purposes in addition to the data requested.

Value

a tibble or an AQS_Data Mart_APIv2 S3 object of transaction sample (raw) data in the AQS submission transaction format (RD) corresponding to the inputs provided.

Note

The AQS API only allows for a single year of transaction data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

See Also

Other Aggregate _by_site functions: aqs_annualsummary_by_site(), aqs_dailysummary_by_site(), aqs_monitors_by_site(), aqs_qa_annualperformanceeval_by_site(), aqs_qa_annualperformanceevaltransaction_by_county(), aqs_qa_annualperformanceevaltransaction_by_site(), aqs_qa_blanks_by_site(), aqs_qa_collocated_assessments_by_site(), aqs_qa_flowrateaudit_by_site(), aqs_qa_flowrateverification_by_site(), aqs_qa_one_point_qc_by_site(), aqs_qa_pep_audit_by_site(), aqs_sampledata_by_site(), aqs_services_by_site()

Examples

#Returns a AQS_Data Mart_APIv2 S3 object of the returns
         ## Not run:  #   returns all ozone transaction data for the
                   #   Millbrook School site (#0014) in Wake County, NC for
                   #   June 18, 2017
                   aqs_transactionsample_by_site(parameter = "44201",
                                                 bdate = as.Date("20170618",
                                                         format = "%Y%m%d"),
                                                 edate = as.Date("20170618",
                                                          format = "%Y%m%d"),
                                                 stateFIPS = "37",
                                                 countycode = "183",
                                                 sitenum = "0014"
                                                 )
                 
## End(Not run)