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
/
index.html
245 lines (224 loc) · 12.8 KB
/
index.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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html>
<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.0">
<title>'DBHYDRO' Hydrologic and Water Quality Data • 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="'DBHYDRO' Hydrologic and Water Quality Data">
<meta property="og:description" content="Client for programmatic access to the South Florida Water
Management District's 'DBHYDRO' database at
<https://www.sfwmd.gov/science-data/dbhydro>, with functions
for accessing hydrologic and water quality data. ">
<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-article">
<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">
<!-- README.md is generated from README.Rmd. Please edit that file -->
<p><img src="https://github.com/ropensci/dbhydroR/raw/master/inst/images/profile.png"></p>
<div id="programmatic-access-to-the-south-florida-water-management-districts-dbhydro-database" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#programmatic-access-to-the-south-florida-water-management-districts-dbhydro-database" class="anchor"></a>Programmatic access to the South Florida Water Management District’s <a href="https://www.sfwmd.gov/science-data/dbhydro">DBHYDRO database</a>
</h1></div>
<p><a href="http://www.repostatus.org/#active"><img src="http://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active - The project has reached a stable, usable state and is being actively developed."></a> <a href="https://travis-ci.org/ropensci/dbhydroR"><img src="https://travis-ci.org/ropensci/dbhydroR.svg?branch=master" alt="Travis-CI Build Status"></a> <a href="https://cran.r-project.org/package=dbhydroR"><img src="http://www.r-pkg.org/badges/version/dbhydroR" alt="CRAN_Status_Badge"></a> <a href="https://cran.r-project.org/package=dbhydroR"><img src="http://cranlogs.r-pkg.org/badges/dbhydroR" alt="CRAN RStudio mirror downloads"></a> <a href="https://github.com/ropensci/onboarding/issues/61"><img src="https://badges.ropensci.org/61_status.svg"></a> <a href="https://zenodo.org/badge/latestdoi/64503356"><img src="https://zenodo.org/badge/64503356.svg" alt="DOI"></a></p>
<p><code>dbhydroR</code> provides scripted access to the South Florida Water Management District’s DBHYDRO database which holds over 35 million hydrologic and water quality records from the Florida Everglades and surrounding areas.</p>
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<div id="stable-version-from-cran" class="section level3">
<h3 class="hasAnchor">
<a href="#stable-version-from-cran" class="anchor"></a>Stable version from CRAN</h3>
<p><code>install.packages("dbhydroR")</code></p>
</div>
<div id="or-development-version-from-github" class="section level3">
<h3 class="hasAnchor">
<a href="#or-development-version-from-github" class="anchor"></a>or development version from Github</h3>
<p><code>install.packages("devtools") # Requires RTools if using Windows</code></p>
<p><code><a href="http://www.rdocumentation.org/packages/devtools/topics/reexports">devtools::install_github("ropensci/dbhydroR")</a></code></p>
</div>
</div>
<div id="usage" class="section level2">
<h2 class="hasAnchor">
<a href="#usage" class="anchor"></a>Usage</h2>
<div id="load-dbhydror" class="section level3">
<h3 class="hasAnchor">
<a href="#load-dbhydror" class="anchor"></a>Load dbhydroR</h3>
<p><code>library("dbhydroR")</code></p>
</div>
<div id="water-quality-data" class="section level3">
<h3 class="hasAnchor">
<a href="#water-quality-data" class="anchor"></a>Water Quality Data</h3>
<p>Station IDs and date ranges can be viewed in the <a href="https://www.sfwmd.gov/documents-by-tag/emmaps">Environmental Monitoring Location Maps</a>. Test names can be viewed in the <a href="http://my.sfwmd.gov/dbhydroplsql/show_dbkey_info.show_data_type_info">Data Types Metadata Table</a>.</p>
<div id="one-variable-at-one-station" class="section level4">
<h4 class="hasAnchor">
<a href="#one-variable-at-one-station" class="anchor"></a>One variable at one station</h4>
<pre><code><a href="reference/get_wq.html">get_wq(station_id = "FLAB08", date_min = "2011-03-01",
date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")</a></code></pre>
</div>
<div id="one-variable-at-multiple-stations" class="section level4">
<h4 class="hasAnchor">
<a href="#one-variable-at-multiple-stations" class="anchor"></a>One variable at multiple stations</h4>
<pre><code><a href="reference/get_wq.html">get_wq(station_id = c("FLAB08","FLAB09"), date_min = "2011-03-01",
date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")</a></code></pre>
</div>
<div id="one-variable-at-a-wildcard-station" class="section level4">
<h4 class="hasAnchor">
<a href="#one-variable-at-a-wildcard-station" class="anchor"></a>One variable at a wildcard station</h4>
<pre><code><a href="reference/get_wq.html">get_wq(station_id = c("FLAB0%"), date_min = "2011-03-01",
date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")</a></code></pre>
</div>
<div id="multiple-variables-at-multiple-stations" class="section level4">
<h4 class="hasAnchor">
<a href="#multiple-variables-at-multiple-stations" class="anchor"></a>Multiple variables at multiple stations</h4>
<pre><code><a href="reference/get_wq.html">get_wq(station_id = c("FLAB08","FLAB09"), date_min = "2011-03-01",
date_max = "2012-05-01", test_name = c("CHLOROPHYLLA-SALINE",
"SALINITY"))</a></code></pre>
</div>
<div id="operate-on-raw-data" class="section level4">
<h4 class="hasAnchor">
<a href="#operate-on-raw-data" class="anchor"></a>Operate on raw data</h4>
<pre><code>raw_data <- get_wq(station_id = "FLAB08", date_min = "2011-03-01",
date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE", raw = TRUE)
clean_wq(raw_data)</code></pre>
</div>
</div>
<div id="hydrologic-data" class="section level3">
<h3 class="hasAnchor">
<a href="#hydrologic-data" class="anchor"></a>Hydrologic data</h3>
<p>Station IDs and date ranges can be viewed in the <a href="https://www.sfwmd.gov/documents-by-tag/emmaps">Environmental Monitoring Location Maps</a>.</p>
<div id="identify-unique-time-series-dbkeys-before-hand" class="section level4">
<h4 class="hasAnchor">
<a href="#identify-unique-time-series-dbkeys-before-hand" class="anchor"></a>Identify unique time series (dbkeys) before-hand</h4>
<pre><code><a href="reference/get_dbkey.html">get_dbkey(stationid = "C111%", stat = 'MEAN', category = "WQ", detail.level = "full")
get_hydro(dbkey = 38104, date_min = "2009-01-01", date_max = "2009-01-12")</a></code></pre>
</div>
<div id="pass-station-info-on-the-fly" class="section level4">
<h4 class="hasAnchor">
<a href="#pass-station-info-on-the-fly" class="anchor"></a>Pass station info on-the-fly</h4>
<pre><code><a href="reference/get_hydro.html">get_hydro(date_min = "2013-01-01", date_max = "2013-02-02",
stationid = "JBTS", category = "WEATHER", param = "WNDS",
freq = "DA", stat = "MEAN", recorder = "CR10", agency = "WMD")</a></code></pre>
</div>
<div id="operate-on-raw-data-1" class="section level4">
<h4 class="hasAnchor">
<a href="#operate-on-raw-data-1" class="anchor"></a>Operate on raw data</h4>
<pre><code>raw_data <- get_hydro(date_min = "2013-01-01", date_max = "2013-02-02",
stationid = "JBTS", category = "WEATHER", param = "WNDS",
freq = "DA", stat = "MEAN", recorder = "CR10", agency = "WMD", raw = TRUE)
clean_hydro(raw_data)</code></pre>
</div>
</div>
</div>
<div id="references" class="section level2">
<h2 class="hasAnchor">
<a href="#references" class="anchor"></a>References</h2>
<p><code><a href="articles/dbhydroR.html">vignette("dbhydroR", package = "dbhydroR")</a></code></p>
<p><a href="https://www.sfwmd.gov/sites/default/files/documents/dbhydrobrowseruserdocumentation.pdf">DBHYDRO User’s Guide</a></p>
</div>
<div id="meta" class="section level2">
<h2 class="hasAnchor">
<a href="#meta" class="anchor"></a>Meta</h2>
<ul>
<li><p>Please <a href="https://github.com/ropensci/dbhydroR/issues">report any issues or bugs</a>.</p></li>
<li><p>Get citation information for <code>dbhydroR</code> in R by running <code>citation(package = 'dbhydroR')</code></p></li>
<li><p>Please note that this project is released with a <a href="https://github.com/ropensci/dbhydroR/blob/master/CONDUCT.html">Contributor Code of Conduct</a>. By participating in this project you agree to abide by its terms</p></li>
</ul>
<p><a href="http://ropensci.org"><img src="https://ropensci.org/public_images/github_footer.png" alt="ropensci_footer"></a></p>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=dbhydroR">https://cloud.r-project.org/package=dbhydroR</a>
</li>
<li>Browse source code at <br><a href="https://github.com/ropensci/dbhydroR">https://github.com/ropensci/dbhydroR</a>
</li>
<li>Report a bug at <br><a href="https://github.com/ropensci/dbhydroR/issues">https://github.com/ropensci/dbhydroR/issues</a>
</li>
</ul>
</div>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li>GPL</li>
</ul>
</div>
<div class="citation">
<h2>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html">Citing dbhydroR</a></li>
</ul>
</div>
<div class="developers">
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Joseph Stachelek <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0002-5924-2464" target="orcid.widget"><img src="https://members.orcid.org/sites/default/files/vector_iD_icon.svg" class="orcid" height="16"></a> </li>
</ul>
</div>
</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>