Repository navigation
Expand file tree
/
Copy pathEQ_AssessmentUnits.Rd
More file actions
78 lines (66 loc) · 3.03 KB
/
Copy pathEQ_AssessmentUnits.Rd
File metadata and controls
78 lines (66 loc) · 3.03 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EQ_AssessmentUnits.R
\name{EQ_AssessmentUnits}
\alias{EQ_AssessmentUnits}
\title{Query and return ATTAINS Assessment Units data via Expert Query web services}
\usage{
EQ_AssessmentUnits(
api_key = NULL,
au_name = NULL,
au_status = "Active",
auid = NULL,
region = NULL,
report_cycle = NULL,
statecode = NULL,
use_class = NULL,
water_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{au_name}{Character string. The name assigned to an Assessment Unit by the Organization.
Default = NULL.}
\item{au_status}{Character string. The current condition or status of an Assessment Unit.
Options are "Active", "Historical" or "Retired". Default = "Active".}
\item{auid}{Character string. A unique identifier assigned to an Assessment Unit by the
Organization. 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.}
\item{report_cycle}{Character string. The Integrated Reporting cycle of the data. Format is
"YYYY" or "latest", which will select the most recent available cycle. Default = "latest".}
\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.}
\item{use_class}{Character string. The Use Class assigned to an Assessment Unit. Options are
"CULTURAL_USE", "DRINKING_WATER_USE", "ECOLOGICAL USE", "FISHCONSUMPTION_USE", "OTHER_USE",
and "RECREATION_USE". 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.}
}
\value{
A data frame of ATTAINS Assessment Units with the columns "region", "state",
"organizationType", "organizationId", "organizationName", "waterType", "locationTypeCode",
"locationText", "useClassName", "assessmentUnitId", "assessmentUnitName", "assessmentUnitStatus",
"reportingCycle", "cycleId", "locationDescription", "sizeSource", "sourceScale", "waterSize",
and "waterSizeUnits".
}
\description{
Query and return ATTAINS Assessment Units 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"
# Active estaury Assessment Units from Maryland
MD_estuary <- EQ_AssessmentUnits(statecode = "MD",
water_type = "ESTUARY",
api_key = testkey)
# Active Assessment Units from Rhode Island from the 2016 report cycle
RI_aus_2016 <- EQ_Assessments(statecode = "RI",
report_cycle = 2016,
api_key = testkey)
}
}