/CoRiverNF

R data package for Colorado River Natural Flows

Primary LanguageR

CoRiverNF

R-CMD-check

A data only R package containing natural flow data for the Colorado River Basin. Data is included at the natural flow basin node level used by the Colorado River Simulation (CRSS).

The package is a convenient way to access the Colorado River Natural Flow data available here. Every effort will be made to update the package to include the most recent natural flow data.

The package is based on the 1906-2020 natural flow data with a date of April 19, 2023.

Installation

The data can be accessed by installing this package from GitHub:

# install.packages("remotes")

remotes::install_github("BoulderCodeHub/CoRiverNF", build_vignettes = TRUE)

Note that when installing from GitHub, warnings are treated as errors. This means if xts is built under a newer version of R than you have installed, then the installation of CoRiverNF will fail. You can resolve this by either installing the newer version of R, or by setting the R_REMOTES_NO_ERRORS_FROM_WARNINGS environment variable to "true" before installation.

Using in R

The package includes monthly, calendar year, and water year data for total and intervening natural flow in 6 data sets:

  • monthlyTot
  • monthlyInt
  • cyAnnTot
  • cyAnnInt
  • wyAnnTot
  • wyAnnInt

You can easily access these data using natural flow node abbreviated names, and the methods used by xts objects to subset time series data. For example, the 2000-2015 data at Lees Ferry can be accessed with cyAnnTot$LeesFerry['2000/']. For more examples see the vignette: vignette("CoRivNatFlow", package = "CoRiverNF").

Reproducing the Data

The included data can be recreated by downloading the package code, or copying the code and Excel file located in data-raw.

To run the code, edit the path to the Excel file located in the "User Input" section of the getHistoricalNFData.R file and then source that file.

Log

  • 2023-04-21: version 2020.0 available
  • 2021-04-20: version 2019.0 available
  • 2020-01-23: version 0.7.0 available - updated to 1906 - 2018 data
  • 2019-04-15: version 0.6.0 available - updated to 1906 - 2017 data
  • 2018-11-28: version 0.5.0 available - updated to 1906 - 2016 data
  • 2018-01-24: version 0.4.1 available
  • 2017-09-06: version 0.4.0 available - updated to 1906 - 2015 data
  • 2017-02-10: version 0.3 available - updated to 1906 - 2014 data
  • 2016-10-18: version 0.2 available
  • 2016-06-16: version 0.1 ready for use