Repository navigation
Expand file tree
/
Copy pathEQ_TMDLs.Rd
More file actions
169 lines (138 loc) · 7.56 KB
/
Copy pathEQ_TMDLs.Rd
File metadata and controls
169 lines (138 loc) · 7.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EQ_TMDLs.R
\name{EQ_TMDLs}
\alias{EQ_TMDLs}
\title{Query and return ATTAINS TMDL data via Expert Query web services}
\usage{
EQ_TMDLs(
api_key = NULL,
act_agency = NULL,
act_id = NULL,
act_name = 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,
region = NULL,
statecode = NULL,
tmdl_date_end = NULL,
tmdl_date_start = NULL,
water_type = NULL,
ad_param = NULL,
ad_param_group = NULL,
mos_exp = NULL,
mos_imp = NULL,
npdes_id = NULL,
other_id = NULL,
pollutant = NULL,
poll_group = NULL,
source_type = NULL
)
}
\arguments{
\item{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}
\item{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.}
\item{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.}
\item{act_name}{Character string. The name associated with the action.Default = NULL.}
\item{au_name}{Character string. The name assigned to an Assessment Unit by the Organization.
Default = NULL.}
\item{auid}{Character string. A unique identifier assigned to an Assessment Unit by the
Organization. Default = NULL.}
\item{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.}
\item{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.}
\item{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.}
\item{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.}
\item{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.}
\item{indian_country}{Character string. Indicates if the water is either wholly or partially in
Indian country. Options are "Yes" or "No". Default = NULL.}
\item{org_id}{Character string. A unique identifier assigned to the Organization. Options can
be viewed with EQ_DomainValues("org_id"). Default = NULL.}
\item{org_name}{Character string. A unique name assigned to the Organization. Options can
be viewed with EQ_DomainValues("org_name"). Default = NULL.}
\item{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.}
\item{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.
Default = NULL.}
\item{tmdl_date_end}{Character string. This should correspond to the ending date of the date
range that EPA approved the official final TMDL submitted (such as the date on the approval
letter). Format is "YYYY-MM-DD". Default = NULL.}
\item{tmdl_date_start}{Character string. This should correspond to the starting date of the date
range that EPA approved the official final TMDL submitted (such as the date on the approval
letter). Format is "YYYY-MM-DD". Default = NULL.}
\item{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.}
\item{ad_param}{Character string. In the context of a TMDL, Addressed Parameters refer to
associated parameters (parameters identified as causes of impairment in the Section 303(d) list
or later identified as such through the TMDL process) that are being addressed by the pollutant
TMDL. Options can be viewed with EQ_DomainValues("ad_param"). Default = NULL.}
\item{ad_param_group}{Character string. Groups of Addressed Parameters. Options can be viewed
with EQ_DomainValues("ad_param_group").Default = NULL.}
\item{mos_exp}{Character string. Refers to the Explicit Margin of Safety for the Associated
Pollutant as identified in the TMDL. Options can be viewed with EQ_DomainValues("mos_exp").
Default = NULL.}
\item{mos_imp}{Character string. Refers to the Implicit Margin of Safety for the Associated
Pollutant as identified in the TMDL. Options can be viewed with EQ_DomainValues("mos_imp").
Default = NULL.}
\item{npdes_id}{Character string. Identification numbers of the NPDES permits within the
waterbody and are associated to a TMDL pollutant. Default = NULL.}
\item{other_id}{Character string. Alternative code identifying the TMDL Report (an example could
be a state assigned identifier that is different from the ID in the Action ID). Default = NULL.}
\item{pollutant}{Character string. Indicates the Pollutant for which the TMDL load was
calculated. Options can be viewed with EQ_DomainValues("pollutant"). Default = NULL.}
\item{poll_group}{Character string. Indicates the group the Pollutant belongs to. Options can
be viewed with EQ_DomainValues("poll_group"). Default = NULL.}
\item{source_type}{Character string. Indicates the Source breakdown for the TMDL. Options are
"Nonpoint source", "Both", "Point source", and "Unknown". Default = NULL.}
}
\value{
A data frame of ATTAINS TMDLs with the columns "objectId", "region", "state",
"organizationType", "organizationId", "organizationName", "waterType", "pollutantGroup",
"pollutant", "addressedParameterGroup", "addressedParameter", "sourceType", "npdesIdentifier",
"otherIdentifier", "actionId", "actionName", "actionAgency", "inIndianCountry",
"explicitMarginOfSafety", "implicitMarginOfSafety", "includeInMeasure", "completionDate",
"tmdlDate", "fiscalYearEstablished", "assessmentUnitId", "assessmentUnitName", "loadAllocation",
"loadAllocationUnits", "locationDescription", "tmdlEndpoint", "waterSize", "waterSizeUnits",
"wasteLoadAllocation", and "planSummaryLink".
}
\description{
Query and return ATTAINS TMDL data via Expert Query web services
}
\examples{
\dontrun{
# to run examples add your api key below
# to get an API key: https://owapps.epa.gov/expertquery/api-key-signup
testkey <- "YOURAPIKEY"
# South Dakota query for source type equal to "Nonpoint source"
SD_nonpoint_tmdls <- EQ_TMDLs(statecode = "SD",
source_type = "Nonpoint source",
api_key = testkey)
# Region 4 TMDLs with addressed parameter group "ALGAL GROWTH"
R4_paramgroup_algalgrowth <- EQ_TMDLs(region = 4,
ad_param_group = "ALGAL GROWTH",
api_key = testkey)
}
}