'DBHYDRO' Hydrologic and Water Quality Data

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.


Project Status: Active - The project has reached a stable, usable state and is being actively developed. Travis-CI Build Status CRAN_Status_Badge CRAN RStudio mirror downloads DOI

dbhydroR 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.

Installation

install.packages("dbhydroR")

or development version from Github

install.packages("devtools") # Requires RTools if using Windows

devtools::install_github("ropensci/dbhydroR")

Usage

Load dbhydroR

library("dbhydroR")

Water Quality Data

Station IDs and date ranges can be viewed in the Environmental Monitoring Location Maps. Test names can be viewed in the Data Types Metadata Table.

One variable at one station

get_wq(station_id = "FLAB08", date_min = "2011-03-01", 
      date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")

One variable at multiple stations

get_wq(station_id = c("FLAB08","FLAB09"), date_min = "2011-03-01",
      date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")

One variable at a wildcard station

get_wq(station_id = c("FLAB0%"), date_min = "2011-03-01", 
      date_max = "2012-05-01", test_name = "CHLOROPHYLLA-SALINE")

Multiple variables at multiple stations

get_wq(station_id = c("FLAB08","FLAB09"), date_min = "2011-03-01",
      date_max = "2012-05-01", test_name = c("CHLOROPHYLLA-SALINE",
      "SALINITY"))

Operate on raw data

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)

Hydrologic data

Station IDs and date ranges can be viewed in the Environmental Monitoring Location Maps.

Identify unique time series (dbkeys) before-hand

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")

Pass station info on-the-fly

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")

Operate on raw data

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)

References

vignette("dbhydroR", package = "dbhydroR")

DBHYDRO User's Guide

Meta

  • Please report any issues or bugs.

  • Get citation information for dbhydroR in R by running citation(package = 'dbhydroR')

  • Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms

ropensci_footer

News

dbhydroR 0.2-7 (2019-02-15)

Bug fixes

  • Fixed critical bug in get_hydro causing data parsing failure in all cases (#16)

dbhydroR 0.2-6 (2018-07-19)

Bug fixes

  • Fixed critical bug in get_hydro causing data parsing failure in all cases

dbhydroR 0.2-5 (2018-05-21)

Bug fixes

  • get_dbkey was incorrectly processing data headers

Minor changes

  • Rebranded from ropenscilabs to ropensci
  • Converted vignette to rmarkdown

dbhydroR 0.2-4 (2017-10-30)

Bug fixes

  • The ArcGIS online station map no longer resolves. Links have been updated.
  • Sweave sty files are excluded in CRAN build.

dbhydroR 0.2-3 (2017-08-02)

Bug fixes

  • get_hydro() now resolves multiple matching of on-the-fly dbkeys to the one with the longest period of record.

Minor changes

  • Fixed broken links
  • Add rOpenSci badge

dbhydroR 0.2-2 (2017-02-03)

Bug fixes

get_hydro() now works if a dbkey contains leading zeros

dbhydroR 0.2-1 (2016-11-23)

Minor changes

  • Improved installation instructions in vignette.
  • Added package level documentation.
  • Added rOpenSci branding.
  • Use https. #6

dbhydroR 0.2

Major changes

  • The package API has been changed to underscored function names. getwq(), gethydro(), and getdbkey() are now deprecated in favor of get_wq(), get_hydro(), get_dbkey().

Bug fixes

  • getdbkey() is no longer limited to < 100 results
  • MDL (Minumum Detection Limit) handling now occurs in getwq() regardless of how the raw parameter is set
  • getwq() returns a no data warning even if the raw parameter is set to TRUE
  • gethydro() and getwq() date/time stamps are now forced to the EST timezone independently of the user environment
  • The character encoding of function results is forced to UTF-8 regardless of the user environment

Minor changes

  • Documentation formatting is now consistent with CRAN policies
  • Added links to the ArcGIS Online Station Map in the README and vignette
  • getdbkey() coordinates are now in decimal degree format

dbhydroR 0.1-6

Minor changes

  • Added argument to handle MDLs (Minimum Detection Limits) in getwq()

dbhydroR 0.1-5

Major changes

  • Added ability to pass a vector of values to getdbkey() arguments
  • Added ability to fully define a unique dbkey in getdbkey()

Minor changes

  • Document MDL handling in cleanwq()
  • Added unit tests
  • Remove standalone plotting functions
  • Cleanup source code formatting

dbhydroR 0.1-4

Bug fixes

  • Improvements to gethydro() to guess missing column names of instantaneous data

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("dbhydroR")

0.2-7 by Joseph Stachelek, 6 months ago


https://github.com/ropensci/dbhydroR


Report a bug at https://github.com/ropensci/dbhydroR/issues


Browse source code at https://github.com/cran/dbhydroR


Authors: Joseph Stachelek [aut, cre]


Documentation:   PDF Manual  


Task views: Hydrological Data and Modeling


GPL license


Imports httr, reshape2, XML

Suggests testthat, knitr, rmarkdown


See at CRAN