rvn_rvc_from_custom_output: Generate RVC file from Custom Output CSVs

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Generate RVC file from Custom Output CSVs

Description

Creates an initial conditions rvc file that specifies the initial state using the information from the supplied custom output file.

Usage

rvn_rvc_from_custom_output(filename, custfiles, FUN, init_date = NULL, ...)

Arguments

filename	filepath of rvc file to be created (with .rvc extension)
custfiles	array of filepaths to Raven Custom Output files (must be ByHRU)
FUN	the aggregation function to be applied to state variables (e.g. mean, passed to sapply)
init_date	datetime of model start (optional, can be calculated from Custom Output files)
...	optional arguments passed to rvn_rvc_write (e.g. author, description)

Value

TRUE	if executed successfully

Author(s)

Leland Scantlebury

Examples

# Create array of custom output file(s)
custout <- c(system.file("extdata","run1_SNOW_Daily_Average_ByHRU.csv",package = "RavenR"))

# Create rvc file of mean snow for each HRU
rvn_rvc_from_custom_output(filename = file.path(tempdir(), "Blank.rvc"),
                           custfiles = custout,
                           FUN = mean)

rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.