Package: RavenR 2.2.3

RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Utilities for processing input and output files associated with the Raven Hydrological Modelling Framework. Includes various plotting functions, model diagnostics, reading output files into extensible time series format, and support for writing Raven input files. The 'RavenR' package is also archived at Chlumsky et al. (2020) <doi:10.5281/zenodo.4248183>. The Raven Hydrologic Modelling Framework method can be referenced with Craig et al. (2020) <doi:10.1016/j.envsoft.2020.104728>.

Authors:Robert Chlumsky [cre, aut], James Craig [ctb, aut], Leland Scantlebury [ctb, aut], Simon Lin [ctb, aut], Sarah Grass [ctb, aut], Genevieve Brown [ctb, aut], Rezgar Arabzadeh [ctb, aut]

RavenR_2.2.3.tar.gz
RavenR_2.2.3.zip(r-4.7)RavenR_2.2.3.zip(r-4.6)RavenR_2.2.3.zip(r-4.5)
RavenR_2.2.3.tgz(r-4.6-x86_64)RavenR_2.2.3.tgz(r-4.6-arm64)RavenR_2.2.3.tgz(r-4.5-x86_64)RavenR_2.2.3.tgz(r-4.5-arm64)
RavenR_2.2.3.tar.gz(r-4.7-arm64)RavenR_2.2.3.tar.gz(r-4.7-x86_64)RavenR_2.2.3.tar.gz(r-4.6-arm64)RavenR_2.2.3.tar.gz(r-4.6-x86_64)
RavenR_2.2.3.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
RavenR/json (API)

# Install 'RavenR' in R:

install.packages('RavenR', repos = c('https://rchlumsk.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rchlumsk/ravenr/issues

Uses libs:

c++– GNU Standard C++ Library v3

Datasets:

rvn_custom_data - Custom Output Data from Raven
rvn_hydrograph_data - Hydrograph Data from Raven
rvn_tidyhydat_sample - Tidyhydat sample data for RavenR package
rvn_watershed_data - Watershed Storage Data from Raven
rvn_weathercan_metadata_sample - Weathercan sample metadata for RavenR package
rvn_weathercan_sample - Weathercan sample data for RavenR package

On CRAN:

diagnostics hydrology modeling modelling visualization water water-resources watershed cpp

7.17 score 41 stars 30 scripts 369 downloads 92 exports 79 dependencies

Last updated from:2b4ea0cff6. Checks:13 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	187
linux-devel-x86_64	OK	213
source / vignettes	OK	249
linux-release-arm64	OK	181
linux-release-x86_64	OK	202
macos-release-arm64	OK	176
macos-release-x86_64	OK	266
macos-oldrel-arm64	OK	246
macos-oldrel-x86_64	OK	575
windows-devel	OK	166
windows-release	OK	241
windows-oldrel	OK	179
wasm-release	OK	137

Exports:%>%%notin%cmax ggplotColours hhmmss2dec rvn_annual_peak rvn_annual_peak_error rvn_annual_peak_event rvn_annual_peak_event_error rvn_annual_peak_timing_error rvn_annual_quantiles rvn_annual_quantiles_plot rvn_annual_volume rvn_apply_wyearly rvn_apply_wyearly_which_max_xts rvn_budyko_plot rvn_calc_runoff_coeff rvn_csv_read rvn_cum_plot_flow rvn_custom_output_plot rvn_custom_read rvn_df_to_Raven_table rvn_dist_lonlat rvn_download rvn_exhaustive_mb_read rvn_fdc_plot rvn_flow_residuals rvn_flow_scatterplot rvn_flow_spaghetti rvn_forcings_plot rvn_forcings_read rvn_fortify_xts rvn_gen_obsweights rvn_get_prd rvn_hyd_dygraph rvn_hyd_extract rvn_hyd_plot rvn_hyd_read rvn_met_interpolate rvn_met_recordplot rvn_month_names rvn_monthly_vbias rvn_num_days rvn_num_days_month rvn_res_dygraph rvn_res_extract rvn_res_plot rvn_res_read rvn_run rvn_rvc_from_custom_output rvn_rvc_res rvn_rvc_write rvn_rvh_blankHRUdf rvn_rvh_blankSBdf rvn_rvh_cleanhrus rvn_rvh_overwrite rvn_rvh_query rvn_rvh_read rvn_rvh_subbasin_network_plot rvn_rvh_subbasin_visnetwork_plot rvn_rvh_summarize rvn_rvh_write rvn_rvh_write_subbasingroup rvn_rvi_commandupdate rvn_rvi_connections rvn_rvi_getparams rvn_rvi_process_diagrammer rvn_rvi_process_ggplot rvn_rvi_read rvn_rvi_write_template rvn_rvp_calib_template rvn_rvp_fill_template rvn_rvt_read rvn_rvt_tidyhydat rvn_rvt_write rvn_rvt_write_met rvn_stringpad rvn_substrLeft rvn_substrMLeft rvn_substrMRight rvn_substrRight rvn_theme_RavenR rvn_ts_infill rvn_watershed_read rvn_watershedmeb_read rvn_which_max_xts rvn_write_Raven_header rvn_write_Raven_label rvn_write_Raven_newfile rvn_write_Raven_table rvn_wyear_indices rvn_xts_plot

Dependencies:base64enc bit bit64 bitops bslib cachem cli clipr colorspace cowplot cpp11 crayon DiagrammeR digest dplyr dygraphs evaluate farver fastmap fontawesome fs gdata generics ggplot2 glue gtable gtools highr hms htmltools htmlwidgets igraph isoband jquerylib jsonlite knitr labeling lattice lifecycle lubridate magrittr Matrix memoise mime pillar pkgconfig prettyunits progress purrr R6 rappdirs RColorBrewer Rcpp RCurl readr rlang rmarkdown rstudioapi S7 sass scales stringi stringr tibble tidyr tidyselect timechange tinytex tzdb utf8 vctrs viridisLite visNetwork vroom withr xfun xts yaml zoo

Introduction to RavenR

Rendered fromIntroduction_to_RavenR.Rmdusingknitr::rmarkdown

Last update: 2025-07-26
Started: 2021-04-29

Help page	Topics
%notin% operator	%notin%
cmax	cmax
Generate colours consistent with ggplot defaults	ggplotColours
Convert hours, minutes, seconds to decimal hours	hhmmss2dec
Annual Peak Comparison	rvn_annual_peak
Annual Peak Errors	rvn_annual_peak_error
Annual Peak Event Comparison	rvn_annual_peak_event
Annual Peak Event Errors	rvn_annual_peak_event_error
Annual Peak Timing Errors	rvn_annual_peak_timing_error
Calculates Yearly Median, Upper and Lower Quantiles of Flow	rvn_annual_quantiles
Plot of Annual Median, Upper and Lower Quantiles of Flow	rvn_annual_quantiles_plot
Annual Volume Comparison	rvn_annual_volume
Apply function for water year	rvn_apply_wyearly
which.max over water year periods	rvn_apply_wyearly_which_max_xts
Budkyo Plot	rvn_budyko_plot
Generate runoff coefficients upstream of gauges	rvn_calc_runoff_coeff
Read in generic Raven output csv files	rvn_csv_read
Cumulative Plot of model flows	rvn_cum_plot_flow
Custom Output Data from Raven	rvn_custom_data
Plot Raven Custom Output	rvn_custom_output_plot
Read Raven Custom Output files	rvn_custom_read
Sets up tables for writing to Raven input files	rvn_df_to_Raven_table
Calculate distance from long/lat	rvn_dist_lonlat
Downloads Raven	rvn_download
Read in Raven Exhaustive Mass Balance file	rvn_exhaustive_mb_read
Plots summary of watershed forcing functions	rvn_fdc_plot
Residuals of model flows	rvn_flow_residuals
Scatterplot of model flows	rvn_flow_scatterplot
Flow Spaghetti Plot	rvn_flow_spaghetti
Plots summary of watershed forcing functions	rvn_forcings_plot
Read in Raven ForcingFunctions file	rvn_forcings_read
Fortify xts object to specific format	rvn_fortify_xts
Create weights time series for calibration/diagnostic evaluation	rvn_gen_obsweights
Check period input	rvn_get_prd
Read in Raven Hydrograph file	rvn_hyd_dygraph
Extract function for Raven Hydrograph object	rvn_hyd_extract
Create Hydrograph Plot	rvn_hyd_plot
Read in Raven Hydrograph file	rvn_hyd_read
Hydrograph Data from Raven	rvn_hydrograph_data
Interpolate meteorological data using IDW	rvn_met_interpolate
EC Climate Gauge Record Overlap Visualization	rvn_met_recordplot
Months in the Year vector	rvn_month_names
Monthly Volume Bias	rvn_monthly_vbias
Number of Days between two dates	rvn_num_days
Number of Days in Month	rvn_num_days_month
Plot Raven reservoir/lake stage time series using dygraph	rvn_res_dygraph
Extract function for Raven Reservoir object	rvn_res_extract
Plot Reservoir Stage	rvn_res_plot
Read in Raven ReservoirStages file	rvn_res_read
Run Raven Executable	rvn_run
Generate RVC file from Custom Output CSVs	rvn_rvc_from_custom_output
Create initial conditions file for Reservoirs	rvn_rvc_res
Write Raven Initial Condition (rvc) file	rvn_rvc_write
Generate Blank Raven HRU DataFrame	rvn_rvh_blankHRUdf
Generate Blank Raven SubBasin DataFrame	rvn_rvh_blankSBdf
Clean HRU data table.	rvn_rvh_cleanhrus
Write/Overwrite Raven rvh file	rvn_rvh_overwrite rvn_rvh_write
Queries RVH object for subbasins and HRUs of interest	rvn_rvh_query
Read Raven .rvh (watershed discretization) file	rvn_rvh_read
Basic Raven subbasin network plot	rvn_rvh_subbasin_network_plot
Plot subbasin network using visNetwork	rvn_rvh_subbasin_visnetwork_plot
Summarize RVH object	rvn_rvh_summarize
Write a subbasin group to Raven RVH format	rvn_rvh_write_subbasingroup
Update command in Raven input file	rvn_rvi_commandupdate
Generate Hydrological process connections list	rvn_rvi_connections
Retrieve Parameter Information from RVI file Algorithms	rvn_rvi_getparams
Plot Raven hydrologic process network using DiagrammeR	rvn_rvi_process_diagrammer
Plot Raven hydrologic process network	rvn_rvi_process_ggplot
Read Raven .rvi (watershed discretization) file	rvn_rvi_read
Write Raven rvi file based on model configuration templates	rvn_rvi_write_template
Rewrite rvp file with placeholder values	rvn_rvp_calib_template
Rewrite template rvp file with values	rvn_rvp_fill_template
Rvt Mappings Data	rvn_rvt_mappings_data
Read .rvt (Raven time series) file	rvn_rvt_read
EC Streamgauge File Conversion from tidyhydat	rvn_rvt_tidyhydat
Write Raven rvt file from Time Series	rvn_rvt_write
EC Climate Station File Conversion	rvn_rvt_write_met
Pads string with spaces, either right or left justified	rvn_stringpad
substring from the Left	rvn_substrLeft
substring minus characters from the Left	rvn_substrMLeft
substring minus characters from the Right	rvn_substrMRight
substring from the Right	rvn_substrRight
RavenR ggplot theme	rvn_theme_RavenR
tidyhydat sample data for RavenR package	rvn_tidyhydat_sample
Infill discontinuous time series with blank values	rvn_ts_infill
Watershed Storage Data from Raven	rvn_watershed_data
Read in Raven WatershedStorage file	rvn_watershed_read
Read in Raven WatershedMassEnergyBalance file	rvn_watershedmeb_read
weathercan sample metadata for RavenR package	rvn_weathercan_metadata_sample
weathercan sample data for RavenR package	rvn_weathercan_sample
which.max for xts objects	rvn_which_max_xts
Write common Raven file header	rvn_write_Raven_header
Writes common Raven labeled line to file, with optional value (appends)	rvn_write_Raven_label
Opens/Creates a new file, writes common file header.	rvn_write_Raven_newfile
Writes a nicely formatted tables of Raven attributes/parameters	rvn_write_Raven_table
Water Year Indices	rvn_wyear_indices
Create plot from xts data	rvn_xts_plot

Package: RavenR 2.2.3

RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)