Package: RavenR 2.2.2

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.2.tar.gz
RavenR_2.2.2.zip(r-4.5)RavenR_2.2.2.zip(r-4.4)RavenR_2.2.2.zip(r-4.3)
RavenR_2.2.2.tgz(r-4.4-x86_64)RavenR_2.2.2.tgz(r-4.4-arm64)RavenR_2.2.2.tgz(r-4.3-x86_64)RavenR_2.2.2.tgz(r-4.3-arm64)
RavenR_2.2.2.tar.gz(r-4.5-noble)RavenR_2.2.2.tar.gz(r-4.4-noble)
RavenR_2.2.2.tgz(r-4.4-emscripten)RavenR_2.2.2.tgz(r-4.3-emscripten)
RavenR.pdf |RavenR.html✨
RavenR/json (API)

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

Peer review:

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

Uses libs:
  • c++– GNU Standard C++ Library v3
Datasets:

On CRAN:

diagnosticshydrologymodelingmodellingvisualizationwaterwater-resourceswatershed

91 exports 35 stars 3.00 score 83 dependencies 20 scripts 833 downloads

Last updated 3 months agofrom:346c3670dd. Checks:OK: 8 NOTE: 1. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 19 2024
R-4.5-win-x86_64OKAug 19 2024
R-4.5-linux-x86_64NOTEAug 19 2024
R-4.4-win-x86_64OKAug 19 2024
R-4.4-mac-x86_64OKAug 19 2024
R-4.4-mac-aarch64OKAug 19 2024
R-4.3-win-x86_64OKAug 19 2024
R-4.3-mac-x86_64OKAug 19 2024
R-4.3-mac-aarch64OKAug 19 2024

Exports:%>%%notin%cmaxhhmmss2decrvn_annual_peakrvn_annual_peak_errorrvn_annual_peak_eventrvn_annual_peak_event_errorrvn_annual_peak_timing_errorrvn_annual_quantilesrvn_annual_quantiles_plotrvn_annual_volumervn_apply_wyearlyrvn_apply_wyearly_which_max_xtsrvn_budyko_plotrvn_calc_runoff_coeffrvn_csv_readrvn_cum_plot_flowrvn_custom_output_plotrvn_custom_readrvn_df_to_Raven_tablervn_dist_lonlatrvn_downloadrvn_exhaustive_mb_readrvn_fdc_plotrvn_flow_residualsrvn_flow_scatterplotrvn_flow_spaghettirvn_forcings_plotrvn_forcings_readrvn_fortify_xtsrvn_gen_obsweightsrvn_get_prdrvn_hyd_dygraphrvn_hyd_extractrvn_hyd_plotrvn_hyd_readrvn_met_interpolatervn_met_recordplotrvn_month_namesrvn_monthly_vbiasrvn_num_daysrvn_num_days_monthrvn_res_dygraphrvn_res_extractrvn_res_plotrvn_res_readrvn_runrvn_rvc_from_custom_outputrvn_rvc_resrvn_rvc_writervn_rvh_blankHRUdfrvn_rvh_blankSBdfrvn_rvh_cleanhrusrvn_rvh_overwritervn_rvh_queryrvn_rvh_readrvn_rvh_subbasin_network_plotrvn_rvh_subbasin_visnetwork_plotrvn_rvh_summarizervn_rvh_writervn_rvh_write_subbasingrouprvn_rvi_commandupdatervn_rvi_connectionsrvn_rvi_getparamsrvn_rvi_process_diagrammerrvn_rvi_process_ggplotrvn_rvi_readrvn_rvi_write_templatervn_rvp_calib_templatervn_rvp_fill_templatervn_rvt_readrvn_rvt_tidyhydatrvn_rvt_writervn_rvt_write_metrvn_stringpadrvn_substrLeftrvn_substrMLeftrvn_substrMRightrvn_substrRightrvn_theme_RavenRrvn_ts_infillrvn_watershed_readrvn_watershedmeb_readrvn_which_max_xtsrvn_write_Raven_headerrvn_write_Raven_labelrvn_write_Raven_newfilervn_write_Raven_tablervn_wyear_indicesrvn_xts_plot

Dependencies:base64encbitbit64bitopsbslibcachemclicliprcolorspacecowplotcpp11crayonDiagrammeRdigestdplyrdygraphsevaluatefansifarverfastmapfontawesomefsgdatagenericsggplot2gluegtablegtoolshighrhmshtmltoolshtmlwidgetsigraphisobandjquerylibjsonliteknitrlabelinglatticelifecyclelubridatemagrittrMASSMatrixmemoisemgcvmimemunsellnlmepillarpkgconfigprettyunitsprogresspurrrR6rappdirsRColorBrewerRcppRCurlreadrrlangrmarkdownrstudioapisassscalesstringistringrtibbletidyrtidyselecttimechangetinytextzdbutf8vctrsviridisLitevisNetworkvroomwithrxfunxtsyamlzoo

Introduction to RavenR

Robert Chlumsky, Dr. James R. Craig

Rendered fromIntroduction_to_RavenR.Rmdusingknitr::rmarkdownon Aug 19 2024.

Last update: 2024-05-06
Started: 2021-04-29

Readme and manuals

Help Manual

Help pageTopics
%notin% operator%notin%
cmaxcmax
Convert hours, minutes, seconds to decimal hourshhmmss2dec
Annual Peak Comparisonrvn_annual_peak
Annual Peak Errorsrvn_annual_peak_error
Annual Peak Event Comparisonrvn_annual_peak_event
Annual Peak Event Errorsrvn_annual_peak_event_error
Annual Peak Timing Errorsrvn_annual_peak_timing_error
Calculates Yearly Median, Upper and Lower Quantiles of Flowrvn_annual_quantiles
Plot of Annual Median, Upper and Lower Quantiles of Flowrvn_annual_quantiles_plot
Annual Volume Comparisonrvn_annual_volume
Apply function for water yearrvn_apply_wyearly
which.max over water year periodsrvn_apply_wyearly_which_max_xts
Budkyo Plotrvn_budyko_plot
Generate runoff coefficients upstream of gaugesrvn_calc_runoff_coeff
Read in generic Raven output csv filesrvn_csv_read
Cumulative Plot of model flowsrvn_cum_plot_flow
Custom Output Data from Ravenrvn_custom_data
Plot Raven Custom Outputrvn_custom_output_plot
Read Raven Custom Output filesrvn_custom_read
Sets up tables for writing to Raven input filesrvn_df_to_Raven_table
Calculate distance from long/latrvn_dist_lonlat
Downloads Ravenrvn_download
Read in Raven Exhaustive Mass Balance filervn_exhaustive_mb_read
Plots summary of watershed forcing functionsrvn_fdc_plot
Residuals of model flowsrvn_flow_residuals
Scatterplot of model flowsrvn_flow_scatterplot
Flow Spaghetti Plotrvn_flow_spaghetti
Forcings Data from Ravenrvn_forcing_data
Plots summary of watershed forcing functionsrvn_forcings_plot
Read in Raven ForcingFunctions filervn_forcings_read
Fortify xts object to specific formatrvn_fortify_xts
Create weights time series for calibration/diagnostic evaluationrvn_gen_obsweights
Check period inputrvn_get_prd
Read in Raven Hydrograph filervn_hyd_dygraph
Extract function for Raven Hydrograph objectrvn_hyd_extract
Create Hydrograph Plotrvn_hyd_plot
Read in Raven Hydrograph filervn_hyd_read
Hydrograph Data from Ravenrvn_hydrograph_data
Interpolate meteorological data using IDWrvn_met_interpolate
EC Climate Gauge Record Overlap Visualizationrvn_met_recordplot
Months in the Year vectorrvn_month_names
Monthly Volume Biasrvn_monthly_vbias
Number of Days between two datesrvn_num_days
Number of Days in Monthrvn_num_days_month
Plot Raven reservoir/lake stage time series using dygraphrvn_res_dygraph
Extract function for Raven Reservoir objectrvn_res_extract
Plot Reservoir Stagervn_res_plot
Read in Raven ReservoirStages filervn_res_read
Run Raven Executablervn_run
Generate RVC file from Custom Output CSVsrvn_rvc_from_custom_output
Create initial conditions file for Reservoirsrvn_rvc_res
Write Raven Initial Condition (rvc) filervn_rvc_write
Generate Blank Raven HRU DataFramervn_rvh_blankHRUdf
Generate Blank Raven SubBasin DataFramervn_rvh_blankSBdf
Clean HRU data table.rvn_rvh_cleanhrus
Write/Overwrite Raven rvh filervn_rvh_overwrite rvn_rvh_write
Queries RVH object for subbasins and HRUs of interestrvn_rvh_query
Read Raven .rvh (watershed discretization) filervn_rvh_read
Basic Raven subbasin network plotrvn_rvh_subbasin_network_plot
Plot subbasin network using visNetworkrvn_rvh_subbasin_visnetwork_plot
Summarize RVH objectrvn_rvh_summarize
Write a subbasin group to Raven RVH formatrvn_rvh_write_subbasingroup
Update command in Raven input filervn_rvi_commandupdate
Generate Hydrological process connections listrvn_rvi_connections
Retrieve Parameter Information from RVI file Algorithmsrvn_rvi_getparams
Plot Raven hydrologic process network using DiagrammeRrvn_rvi_process_diagrammer
Plot Raven hydrologic process networkrvn_rvi_process_ggplot
Read Raven .rvi (watershed discretization) filervn_rvi_read
Write Raven rvi file based on model configuration templatesrvn_rvi_write_template
Rewrite rvp file with placeholder valuesrvn_rvp_calib_template
Rewrite template rvp file with valuesrvn_rvp_fill_template
Rvt Mappings Datarvn_rvt_mappings_data
Read .rvt (Raven time series) filervn_rvt_read
EC Streamgauge File Conversion from tidyhydatrvn_rvt_tidyhydat
Write Raven rvt file from Time Seriesrvn_rvt_write
EC Climate Station File Conversionrvn_rvt_write_met
Pads string with spaces, either right or left justifiedrvn_stringpad
substring from the Leftrvn_substrLeft
substring minus characters from the Leftrvn_substrMLeft
substring minus characters from the Rightrvn_substrMRight
substring from the Rightrvn_substrRight
RavenR ggplot themervn_theme_RavenR
tidyhydat sample data for RavenR packagervn_tidyhydat_sample
Infill discontinuous time series with blank valuesrvn_ts_infill
Watershed Storage Data from Ravenrvn_watershed_data
Read in Raven WatershedStorage filervn_watershed_read
Read in Raven WatershedMassEnergyBalance filervn_watershedmeb_read
weathercan sample metadata for RavenR packagervn_weathercan_metadata_sample
weathercan sample data for RavenR packagervn_weathercan_sample
which.max for xts objectsrvn_which_max_xts
Write common Raven file headerrvn_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/parametersrvn_write_Raven_table
Water Year Indicesrvn_wyear_indices
Create plot from xts datarvn_xts_plot