Skip to content

Models and Tools for Watershed Flux Estimates

Notifications You must be signed in to change notification settings

miguelcleon/loadflex

 
 

Repository files navigation

loadflex: Models and tools for watershed flux estimates

This package implements several of the most common methods for modeling and predicting watershed solute fluxes and concentrations, including interpolation and regression models, period-weighted averaging, and the composite method. loadflex integrates seamlessly with the USGS's rloadest package and with native R regression models. It offers a uniform interface for any model type, with which you can quickly fit models, generate predictions, and aggregate to monthly or annual values.

The package was developed by Alison Appling and Miguel Leon with the support of Bill McDowell at the University of New Hampshire.

To get started, load the package and type ?loadflex.

To see how to cite this package, type citation("loadflex").

Installation

First-time installation

loadflex makes use of packages that are currently only available from GitHub or the USGS R package repository. To install these packages, run the following lines:

install.packages(
  c("smwrData", "smwrBase", "smwrGraphs", "smwrStats", "smwrQW", "rloadest", "unitted"), 
  repos=c("http://owi.usgs.gov/R", "https://cran.rstudio.com"), 
  dependencies=TRUE, type="both")

you'll also need the devtools package; see https://www.rstudio.com/products/rpackages/devtools/ for special instructions, and also run this command:

install.packages("devtools")

and lastly run this call to actually install loadflex:

devtools::install_github("mcdowelllab/loadflex")

Also please see the installation FAQ on the wiki (https://github.com/McDowellLab/loadflex/wiki/Installation-FAQ) if you run into trouble.

Updates

After the first-time installation, you can update with these commands:

update.packages(
  oldPkgs=  c("smwrData", "smwrBase", "smwrGraphs", "smwrStats", "smwrQW", "rloadest", "unitted"),
  dependencies=TRUE, repos=c("http://owi.usgs.gov/R", "https://cran.rstudio.com"))
devtools::install_github("mcdowelllab/loadflex")

Package status

Please don't worry: yes, some of these status badges are red, but the reasons are minor. You can absolutely still install and run the package. We use the badges as a motivator for us - we're continously raising the bar and working to make loadflex even better.

Name Status
Windows Build: Windows Build status
Linux Build: Linux Build Status
Coveralls: Coveralls Coverage
Codecov: Codecov Coverage

About

Models and Tools for Watershed Flux Estimates

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • R 95.3%
  • HTML 4.7%