# Raven Hydrological Modelling Framework R Support and Analysis

## Documentation for package ‘RavenR’ version 2.2.3

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

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