Skip to contents

Query and return ATTAINS Actions data via Expert Query web services

EQ_Actions.Rd

Query and return ATTAINS Actions data via Expert Query web services

Usage

EQ_Actions(
  api_key = NULL,
  act_agency = NULL,
  act_id = NULL,
  act_name = NULL,
  act_type = NULL,
  au_name = NULL,
  auid = NULL,
  comp_date_end = NULL,
  comp_date_start = NULL,
  fisc_year_end = NULL,
  fisc_year_start = NULL,
  in_meas = NULL,
  indian_country = NULL,
  org_id = NULL,
  org_name = NULL,
  param_name = NULL,
  param_group = NULL,
  region = NULL,
  statecode = NULL,
  water_type = NULL
)

Arguments

api_key

Character string. Users must supply their unique api key to access Expert Query web services. To obtain an api, submit the form at: https://owapps.epa.gov/expertquery/api-key-signup

act_agency

Character string. Denotes the agency that is establishing/issuing the action associated with an Assessment. Options are "State", "Tribe", or "EPA". Default = NULL.

act_id

Character string. Unique Identifier for the Action associated with an Assessment that will be used to track the Action entered (such as the corresponding information and associated documents) in ATTAINS, and its associated name. Default = NULL

act_name

Character string. The name associated with the action.Default = NULL.

act_type

Character string. Identifies the type of Action associated with an Action. Options can be viewed with EQ_DomainValues(act_type).Default = NULL

au_name

Character string. The name assigned to an Assessment Unit by the Organization. Default = NULL.

auid

Character string. A unique identifier assigned to an Assessment Unit by the Organization. Default = NULL.

comp_date_end

Character string. The ending date of the date range during which the Action is planned to be completed. Usually this refers to the date that the TMDL Action date is initially submitted to EPA. Format is "YYYY-MM-DD". Default = NULL.

comp_date_start

Character string. The starting date of the date range during which the Action is planned to be completed. Usually this refers to the date that the TMDL Action date is initially submitted to EPA. Format is "YYYY-MM-DD". Default = NULL.

fisc_year_end

Character string. The ending year for the date range of fiscal years in which a particular action, program, or project was initiated or established. Format is "YYYY". Default = NULL.

fisc_year_start

Character string. The starting year for the date range of fiscal years in which a particular action, program, or project was initiated or established. Format is "YYYY". Default = NULL.

in_meas

Character string. EPA can determine whether the Action should count towards 303(d) measures. Draft Actions get partial credit and finalized Actions get full cred. By default, all measures count towards the measures unless EPA changes this flag for a specific action. Options are "Yes" or "No". Default = NULL.

indian_country

Character string. Indicates if the water is either wholly or partially in Indian country. Options are "Yes" or "No". Default = NULL.

org_id

Character string. A unique identifier assigned to the Organization. Options can be viewed with EQ_DomainValues("org_id"). Default = NULL.

org_name

Character string. A unique name assigned to the Organization. Options can be viewed with EQ_DomainValues("org_name"). Default = NULL.

param_name

The name of the characteristic being monitored and assessed. Options can be viewed with EQ_DomainValues("param_name"). Default = NULL.

param_group

Character string. A collection of related Parameters. Options can be viewed with EQ_DomainValues("param_attain"). Default = NULL.

region

Numeric (integer). Integer from 1 to 10 to identify the EPA region of interest. See https://www.epa.gov/aboutepa/regional-and-geographic-offices for options. Default = NULL.

statecode

Character string. FIPS state alpha code that identifies a state (e.g. statecode = "DE" for Delaware). See https://www.waterqualitydata.us/Codes/statecode for options.

water_type

Character string. An Assessment Unit must have at least one water type, and it may have multiple water types. Options can be viewed with EQ_DomainValues("water_type"). Default = NULL.

Value

A data frame of ATTAINS actions with the columns "objectId", "region", "state", "organizationType", "organizationId", "organizationName", "waterType", "parameterGroup", "parameter", "actionType", "actionId", "actionName", "actionAgency", "inIndianCountry", "includeInMeasure", "completionDate", "assessmentUnitId", "assessmentUnitName", "fiscalYearEstablished", "locationDescription", "waterSize", "waterSizeUnits", and "planSummaryLink".

Examples

if (FALSE) { # \dontrun{

# to run examples add your api key below
# to get an API key: https://owapps.epa.gov/expertquery/api-key-signup
testkey <- "YOURAPIKEY"

# actions from OR established between fiscal years 2018 and 2020
OR_actions_ex <- EQ_Actions(
  statecode = "OR", fisc_year_start = 2018, fisc_year_end = 2020,
  api_key = testkey
)

# 4B Restoration Approach Actions from Region 5
Region5_4B <- EQ_Actions(
  region = 5,
  act_type = "4B Restoration Approach",
  api_key = testkey
)
} # }