Repository navigation
Expand file tree
/
Copy pathEQ_CatchCorr.Rd
More file actions
75 lines (65 loc) · 2.89 KB
/
Copy pathEQ_CatchCorr.Rd
File metadata and controls
75 lines (65 loc) · 2.89 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/EQ_CatchCorr.R
\name{EQ_CatchCorr}
\alias{EQ_CatchCorr}
\title{Query and return ATTAINS Catchment Correspondence data via Expert Query web services}
\usage{
EQ_CatchCorr(
api_key = NULL,
au_name = NULL,
auid = NULL,
org_id = NULL,
org_name = NULL,
region = NULL,
report_cycle = "latest",
statecode = 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{auid}{Character string. A unique identifier assigned to an Assessment Unit by the
Organization. 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{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.}
}
\value{
A data frame of ATTAINS Catchment Correspondence with the columns "objectId", "region",
"state", "organizationType", "organizationId", "organizationName", "assesssmentUnitId",
"assessmentUnitName", "catchmentNhdPlusId", "reportingCycle", and "cycleId".
}
\description{
#' * If using VPN, suggest signing out of VPN before running this function as it can cause
403 error and prevent download of catchment correspondence data.
}
\details{
** Catchment Correspondence queries can generate large files. You must have enough memory
available for these functions to import them into R successfully. Best practice is to make
your initial query as specific as possible to reduce size of file returned.
}
\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"
# Catchment Correspondence for Illinois' Big Muddy River (Assessment Unit IL_N-99)
IL_ILN99 <- EQ_CatchCorr(statecode = "IL",
auid = "IL_N-99",
api_key = testkey)
# Catchment Correspondence for Washington, DC
DC_catchcorr <- EQ_AUsMLs(statecode = "DC",
api_key = testkey)
}
}