This repository has been archived by the owner on Jan 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
get_hydro.html
214 lines (168 loc) · 9.28 KB
/
get_hydro.html
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Retrieve hydrologic data from the DBHYDRO Environmental Database — get_hydro • dbhydroR</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Retrieve hydrologic data from the DBHYDRO Environmental Database — get_hydro" />
<meta property="og:description" content="Retrieve hydrologic data from the DBHYDRO Environmental Database" />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">dbhydroR</a>
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.2.7</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/dbhydroR.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/ropensci/dbhydroR">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Retrieve hydrologic data from the DBHYDRO Environmental Database</h1>
<small class="dont-index">Source: <a href='https://github.com/ropensci/dbhydroR/blob/master/R/dbhydro_get.R'><code>R/dbhydro_get.R</code></a></small>
<div class="hidden name"><code>get_hydro.Rd</code></div>
</div>
<div class="ref-description">
<p>Retrieve hydrologic data from the DBHYDRO Environmental Database</p>
</div>
<pre class="usage"><span class='fu'>get_hydro</span>(<span class='kw'>dbkey</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>date_min</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>date_max</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
<span class='no'>...</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>dbkey</th>
<td><p>character string specifying a unique data series.
See <code><a href='get_dbkey.html'>get_dbkey</a></code></p></td>
</tr>
<tr>
<th>date_min</th>
<td><p>character date must be in YYYY-MM-DD format</p></td>
</tr>
<tr>
<th>date_max</th>
<td><p>character date must be in YYYY-MM-DD format</p></td>
</tr>
<tr>
<th>raw</th>
<td><p>logical default is FALSE, set to TRUE to return data in "long"
format with all comments, qa information, and database codes included.</p></td>
</tr>
<tr>
<th>...</th>
<td><p>Options passed on to <code><a href='get_dbkey.html'>get_dbkey</a></code></p></td>
</tr>
</table>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p><code>get_hydro</code> can be run in one of two ways.</p>
<ul>
<li><p>The first, is to identify one or more <code>dbkeys</code> before-hand that
correspond to unique data series and are passed to the <code>dbkey</code>
argument. <code>dbkeys</code> can be found by:</p><ul>
<li><p>iterative calls to <code><a href='get_dbkey.html'>get_dbkey</a></code> (see example)</p></li>
<li><p>using the Environmental Monitoring Location Maps
(<a href='https://www.sfwmd.gov/documents-by-tag/emmaps'>https://www.sfwmd.gov/documents-by-tag/emmaps</a>)</p></li>
<li><p>using the DBHYDRO Browser
(<a href='http://my.sfwmd.gov/dbhydroplsql/show_dbkey_info.main_menu'>http://my.sfwmd.gov/dbhydroplsql/show_dbkey_info.main_menu</a>).</p></li>
</ul></li>
<li><p>The second way to run <code>get_hydro</code> is to specify additional
arguments to <code>...</code> which are passed to <code><a href='get_dbkey.html'>get_dbkey</a></code>
on-the-fly.</p></li>
</ul><p>By default, <code>get_hydro</code> returns a cleaned output where metadata
(station-name, variable, measurement units) is wholly contained in the column
name. This is accomplished internally by the <code><a href='clean_hydro.html'>clean_hydro</a></code>
function. If additional metadata such as latitude and longitude are desired
set the <code>raw</code> argument to <code>TRUE</code>.</p>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><span class='co'># NOT RUN {</span>
<span class='co'>#One variable/station time series</span>
<span class='fu'>get_hydro</span>(<span class='kw'>dbkey</span> <span class='kw'>=</span> <span class='st'>"15081"</span>, <span class='kw'>date_min</span> <span class='kw'>=</span> <span class='st'>"2013-01-01"</span>, <span class='kw'>date_max</span> <span class='kw'>=</span> <span class='st'>"2013-02-02"</span>)
<span class='co'>#Multiple variable/station time series</span>
<span class='fu'>get_hydro</span>(<span class='kw'>dbkey</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"15081"</span>, <span class='st'>"15069"</span>),
<span class='kw'>date_min</span> <span class='kw'>=</span> <span class='st'>"2013-01-01"</span>, <span class='kw'>date_max</span> <span class='kw'>=</span> <span class='st'>"2013-02-02"</span>)
<span class='co'>#Instantaneous hydro retrieval</span>
<span class='fu'>get_hydro</span>(<span class='kw'>dbkey</span> <span class='kw'>=</span> <span class='st'>"IY639"</span>, <span class='kw'>date_min</span> <span class='kw'>=</span> <span class='st'>"2015-11-01"</span>, <span class='kw'>date_max</span> <span class='kw'>=</span> <span class='st'>"2015-11-04"</span>)
<span class='co'>#Looking up unknown dbkeys on the fly</span>
<span class='fu'>get_hydro</span>(<span class='kw'>stationid</span> <span class='kw'>=</span> <span class='st'>"JBTS"</span>, <span class='kw'>category</span> <span class='kw'>=</span> <span class='st'>"WEATHER"</span>,
<span class='kw'>param</span> <span class='kw'>=</span> <span class='st'>"WNDS"</span>, <span class='kw'>freq</span> <span class='kw'>=</span> <span class='st'>"DA"</span>, <span class='kw'>date_min</span> <span class='kw'>=</span> <span class='st'>"2013-01-01"</span>,
<span class='kw'>date_max</span> <span class='kw'>=</span> <span class='st'>"2013-02-02"</span>)
<span class='co'># }</span></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#details">Details</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Joseph Stachelek.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
</div>
</body>
</html>