Repository navigation
Expand file tree
/
Copy pathEQ_AssessmentUnits.html
More file actions
159 lines (115 loc) · 10.7 KB
/
Copy pathEQ_AssessmentUnits.html
File metadata and controls
159 lines (115 loc) · 10.7 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
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Query and return ATTAINS Assessment Units data via Expert Query web services — EQ_AssessmentUnits • rExpertQuery</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Query and return ATTAINS Assessment Units data via Expert Query web services — EQ_AssessmentUnits"><meta name="description" content="Query and return ATTAINS Assessment Units data via Expert Query web services"><meta property="og:description" content="Query and return ATTAINS Assessment Units data via Expert Query web services"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="../index.html">rExpertQuery</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.0</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/CybertownTraining.html">rExpertQuery Cybertown Training</a></li>
<li><a class="dropdown-item" href="../articles/GettingStartedWithrExpertQuery.html">Getting Started With rExpertQuery</a></li>
</ul></li>
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Query and return ATTAINS Assessment Units data via Expert Query web services</h1>
<div class="d-none name"><code>EQ_AssessmentUnits.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Query and return ATTAINS Assessment Units data via Expert Query web services</p>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">EQ_AssessmentUnits</span><span class="op">(</span></span>
<span> api_key <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> au_name <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> au_status <span class="op">=</span> <span class="st">"Active"</span>,</span>
<span> auid <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> region <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> report_cycle <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> statecode <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> use_class <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> water_type <span class="op">=</span> <span class="cn">NULL</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt id="arg-api-key">api_key<a class="anchor" aria-label="anchor" href="#arg-api-key"></a></dt>
<dd><p>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</p></dd>
<dt id="arg-au-name">au_name<a class="anchor" aria-label="anchor" href="#arg-au-name"></a></dt>
<dd><p>Character string. The name assigned to an Assessment Unit by the Organization.
Default = NULL.</p></dd>
<dt id="arg-au-status">au_status<a class="anchor" aria-label="anchor" href="#arg-au-status"></a></dt>
<dd><p>Character string. The current condition or status of an Assessment Unit.
Options are "Active", "Historical" or "Retired". Default = "Active".</p></dd>
<dt id="arg-auid">auid<a class="anchor" aria-label="anchor" href="#arg-auid"></a></dt>
<dd><p>Character string. A unique identifier assigned to an Assessment Unit by the
Organization. Default = NULL.</p></dd>
<dt id="arg-region">region<a class="anchor" aria-label="anchor" href="#arg-region"></a></dt>
<dd><p>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.</p></dd>
<dt id="arg-report-cycle">report_cycle<a class="anchor" aria-label="anchor" href="#arg-report-cycle"></a></dt>
<dd><p>Character string. The Integrated Reporting cycle of the data. Format is
"YYYY" or "latest", which will select the most recent available cycle. Default = "latest".</p></dd>
<dt id="arg-statecode">statecode<a class="anchor" aria-label="anchor" href="#arg-statecode"></a></dt>
<dd><p>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.</p></dd>
<dt id="arg-use-class">use_class<a class="anchor" aria-label="anchor" href="#arg-use-class"></a></dt>
<dd><p>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.</p></dd>
<dt id="arg-water-type">water_type<a class="anchor" aria-label="anchor" href="#arg-water-type"></a></dt>
<dd><p>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.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>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".</p>
</div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span> <span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># to run examples add your api key below</span></span></span>
<span class="r-in"><span><span class="co"># to get an API key: https://owapps.epa.gov/expertquery/api-key-signup</span></span></span>
<span class="r-in"><span><span class="va">testkey</span> <span class="op"><-</span> <span class="st">"YOURAPIKEY"</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Active estaury Assessment Units from Maryland</span></span></span>
<span class="r-in"><span><span class="va">MD_estuary</span> <span class="op"><-</span> <span class="fu">EQ_AssessmentUnits</span><span class="op">(</span>statecode <span class="op">=</span> <span class="st">"MD"</span>,</span></span>
<span class="r-in"><span> water_type <span class="op">=</span> <span class="st">"ESTUARY"</span>,</span></span>
<span class="r-in"><span> api_key <span class="op">=</span> <span class="va">testkey</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Active Assessment Units from Rhode Island from the 2016 report cycle</span></span></span>
<span class="r-in"><span><span class="va">RI_aus_2016</span> <span class="op"><-</span> <span class="fu"><a href="EQ_Assessments.html">EQ_Assessments</a></span><span class="op">(</span>statecode <span class="op">=</span> <span class="st">"RI"</span>,</span></span>
<span class="r-in"><span> report_cycle <span class="op">=</span> <span class="fl">2016</span>,</span></span>
<span class="r-in"><span> api_key <span class="op">=</span> <span class="va">testkey</span><span class="op">)</span></span></span>
<span class="r-in"><span> <span class="op">}</span> <span class="co"># }</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p>Developed by Hillary Marler.</p>
</div>
<div class="pkgdown-footer-right">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>
</div>
</footer></div>
</body></html>