README.md

In joshualerickson/hydroapps: hydroapps

hydroapps

The goal of {hydroapps} is to to create apps for resource management in the context of hydrology monitoring and reporting. This package relies heavily on USGS API and NRCS API wouldn’t be possible with out it (much thanks). However, this package is highly experimental and is used mostly by myself but I think it’s worth sharing! Please enjoy and contributions are welcome!

Warning!

If having trouble with installation, try downloading {wildlandhydRo} and {streamstats} first.

Also, the reports within the interactive map take a minute or two to generate.

Goals

As of 11/29/2021 the app is functional on Windows 10 OS. Things to work on:

• Looking at adding NLDI and NWS apps.

• water year and year confusion was solved by just defaulting to water year (10/1-9/30). If someone wants options please add to issues or PR.

• reduce package dependencies. Looking to get {wildlandhydRo} on CRAN and then might be able to drop some dependencies and look to get this on CRAN…

• Any ideas? Please let me know!

Installation

This is only in development right now.

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("joshualerickson/hydroapps")

Contributions

This package uses the golem framework and thus uses modules to bring everything together. If you want to help contribute please be aware of this framework, i.e. see here for more details. Other than that, contributions are welcomed!

Basic Example

As of right now there are three running apps (streamstats, usgs_stats, snotel_stats). Just run the following code below and a shiny app will pop-up. If the site has invalid data or is not functioning then the app will not complete.

#interact with the StreamStats API
run_app('streamstats')

#get USGS gauging station stats
run_app('usgs_stats')

#get snotel station stats
run_app('streamstats')

In addition, you can run a couple of functions to just get the reports for USGS and SNOTEL stations.

get_snotel_report(site = '787')

get_usgs_report(site = '12301250')

joshualerickson/hydroapps documentation built on Sept. 4, 2022, 2:48 p.m.