README

CRAN status downloads lifecycle license DOI

RavenR

RavenR is an R package for handling Raven hydrologic modelling framework inputs, outputs, and diagnostics.

Installation

The CRAN version of the package may also installed with:

install.packages("RavenR")

You can also install the latest RavenR version from github with:

if (!require(devtools)) install.packages("devtools")
library(devtools)
devtools::install_github("rchlumsk/RavenR")

The developmental version can be installed from the dev branch with:

if (!require(devtools)) install.packages("devtools")
library(devtools)
devtools::install_github("rchlumsk/RavenR", ref="dev")

Tutorials and Quick Start Guide

Please see the package vignette for an overview of the RavenR package. Sample data is included in the package, so you need only to install the RavenR library and follow along in the guide documents to get started.

The RavenR vignette can be accessed with the browseVignettes function.

browseVignettes("RavenR")

Citation (Publication)

To cite RavenR in publications, please use the publication reference below.

Chlumsky, R., Craig, J. R., Lin, S. G. M., Grass, S., Scantlebury, L., Brown, G., and Arabzadeh, R.: RavenR v2.1.4: an open-source R package to support flexible hydrologic modelling, Geosci. Model Dev., 15, 7017–7030, https://doi.org/10.5194/gmd-15-7017-2022, 2022.

A BibTeX entry for LaTeX users is:

@Article{gmd-15-7017-2022,
title = { v2.1.4: an open-source R package to support flexible hydrologic modelling},
author = {Chlumsky, R. and Craig, J. R. and Lin, S. G. M. and Grass, S. and Scantlebury, L. and Brown, G. and Arabzadeh, R.},
journal = {Geoscientific Model Development},
volume = {15},
year = {2022},
number = {18},
pages = {7017–7030},
url = {https://gmd.copernicus.org/articles/15/7017/2022/},
doi = {10.5194/gmd-15-7017-2022}
}

Citation (Software)

citation("RavenR")

The RavenR software itself can also be cited in publications, use:

Robert Chlumsky, James Craig, Leland Scantlebury, Simon Lin, Sarah Grass, Genevieve Brown and Rezgar Arabzadeh (2022). RavenR: Raven Hydrological Modelling Framework R Support and Analysis. R package version 2.1.9. https://github.com/rchlumsk/RavenR

A BibTeX entry for LaTeX users is:

@Manual{RavenRPackage,
title = {RavenR: Raven Hydrological Modelling Framework R Support and Analysis},
author = {Robert Chlumsky and James Craig and Leland Scantlebury and Simon Lin and Sarah Grass and Genevieve Brown and Rezgar Arabzadeh},
year = {2022},
note = {R package version 2.1.9},
url = {https://github.com/rchlumsk/RavenR},
doi = {10.5281/zenodo.3468441} }

RavenR Wishlist

Any issues or feature requests can be submitted on the Github Issues page as an issue, or discussed more openly on the new Github Discussions page.

Version Update Notes

2.2.1

Minor updates and new functionality, including:

2.2.0

Minor updates and new functionality, including:

2.1.8

Minor updates and new functionality, including:

2.1.7

Minor updates and bug fixes, including:

2.1.4

Updates to a number of functions and new features implemented, including:

2.0.0

Major updates to the package, including core package styling such as function case, naming conventions, and use of ggplot2 libraries for plotting. Some of these include:

See Also