Repository navigation
Expand file tree
/
Copy pathEQ_AUsMLs.Rd
More file actions
95 lines (79 loc) · 3.76 KB
/
Copy pathEQ_AUsMLs.Rd
File metadata and controls
95 lines (79 loc) · 3.76 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EQ_AUsMLs.R
\name{EQ_AUsMLs}
\alias{EQ_AUsMLs}
\title{Query and return ATTAINS Assessment Units with Monitoring Locations data via Expert Query web
services}
\usage{
EQ_AUsMLs(
api_key = NULL,
au_name = NULL,
au_status = "Active",
auid = NULL,
mon_loc_id = NULL,
mon_loc_org = NULL,
org_id = NULL,
org_name = NULL,
region = NULL,
report_cycle = "latest",
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.}
\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{mon_loc_id}{Character string. Unique identifier for the monitoring location.}
\item{mon_loc_org}{Character string. The unique identifier assigned to the Organization that
conducted the monitoring. For all possible options see the WQP domain list for Organizations
here: https://cdx.epa.gov/wqx/download/DomainValues/Organization_CSV.zip.}
\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{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.
Default = NULL.}
\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 Monitoring Locations with the columns
"objectId", "region", "state", "organizationType", "organizationId", "organizationName",
"waterType", "useClassName", "monitoringLocationId", "monitoringLocationOrgId",
"assessmentUnitId", "assessmentUnitName", "assessmentUnitStatus", "reportingCycle",
"locationDescrption", "monitoringLocationDataLink", "sizeSource", "sourceScale", "waterSize",
and "waterSizeUnits".
}
\description{
Query and return ATTAINS Assessment Units with Monitoring Locations 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"
# Alaska Assessment Units with Monitoring Locations
AK_aus_mls <- EQ_AUsMLs(statecode = "AK",
api_key = testkey)
# Red Lake Band of Chippewa Indians (Minnesota) Assessment Units with Monitoring Locations
RedLake_aus_mls <- EQ_AUsMLs(org_id = "REDLAKE",
api_key = testkey)
}
}