aappling-usgs / loadflex Goto Github PK

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 created by Alison Appling and Miguel Leon with the support of Bill McDowell and the McDowell lab at the University of New Hampshire, 2013-2015. Funding for the project was provided by the National Science Foundation, USDA National Institute of Food and Agriculture, and the NH Agricultural Experiment Station. Funding for the example dataset from the Lamprey River was provied by the EPA, NH Water Resources Research Center, NH Agricultural Experiment Station, NH Sea Grant, USGS, and NSF. This work is described in

Appling, A. P., M. C. Leon, and W. H. McDowell. 2015. Reducing bias and quantifying uncertainty in watershed flux estimates: the R package loadflex. Ecosphere 6(12):269. https://doi.org/10.1890/ES14-00517.1

Additional development and maintenance in 2016-present is being done by Alison Appling, Lindsay Carr, and David Watkins of the USGS Office of Water Information.

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

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

Name	Status
Windows Build:
Linux Build:
Coveralls:
USGS Status:

Please consider reporting bugs and asking questions on the Issues page: https://github.com/USGS-R/loadflex/issues

Follow @USGS_R on Twitter for updates on USGS R packages:

The Water Mission Area of the USGS supports maintenance of loadflex through September 2018, and likely further into the future. Resources are available primarily for maintenance and responding to user questions. Some new features may be added as prioritized by the loadflex development team.

This section should only need to be done once per computer.

The following link walks you through an installation of R and RStudio:

Installation Instructions

If you follow those instructions exactly, you should have the USGS R repository (GRAN) added to your R profile. If that step doesn't ring a bell, paste the following into your R console:

rprofile_path = file.path(Sys.getenv("HOME"), ".Rprofile")
write('\noptions(repos=c(getOption(\'repos\'),
    CRAN=\'https://cloud.r-project.org\',
    USGS=\'https://owi.usgs.gov/R\'))\n',
      rprofile_path, 
      append =  TRUE)

cat('Your Rprofile has been updated to include GRAN.
    Please restart R for changes to take effect.')

RESTART RSTUDIO!

Useful links:

• Download R Windows
• Download R Mac
• Download RStudio

This section should also only have to be done once. It assumes the USGS R repository (GRAN) was added to your R profile as described above.

install.packages("loadflex")

Regularly, it is a good idea to update ALL your packages in R. If using RStudio, this is quite easy, there's an Update button in the "Packages" tab. This checks CRAN and GRAN for updates. It is a good idea to click this update regularly.

To install the current development version of the package*:

devtools::install_github("USGS-R/loadflex")

*You will want to initially install loadflex via the install.packages steps described above to get the non-CRAN package dependencies properly installed.

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

Please consider reporting bugs and asking questions on the Issues page: https://github.com/USGS-R/loadflex/issues

Follow @USGS_R on Twitter for updates on USGS R packages:

We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the code of conduct for more information.

This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey (USGS), an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www.usgs.gov/visual-id/credit_usgs.html#copyright

Although this software program has been used by the USGS, no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.

This software is provided "AS IS."