modify_output_filter: modify_output_filter

In ryanrbart/RHESSysIOinR: Tools for Running RHESSys from R

modify_output_filter

Description

Modify a single existing output filter, either from file or based on an existing R object. Will error if given multiple filters. This could be done via normal list modification in R as well.

Usage

modify_output_filter(
  filter_in,
  timestep = NULL,
  output_format = NULL,
  output_path = NULL,
  output_filename = NULL,
  spatial_level = NULL,
  spatial_ID = NULL,
  variables = NULL
)

Arguments

filter_in	Path to the yaml filter file
timestep	The timestep of the filter: 'daily', 'monthly', 'annual', 'hourly'
output_format	The format for the RHESSys output files to be written: 'csv' or 'netcdf'
output_path	The path where RHESSys output will be written.
output_filename	The filename for RHESSys output
spatial_level	The spatial level for output to be collected at/aggregated to: 'basin', 'hillslope', 'zone', 'patch', 'stratum'
spatial_ID	IDs to subset the spatial units by.
variables	The RHESSys internal variable names to output. If aggregating from a finer spatial level use syntax: '<spatial>.<varaible>'

Author(s)

Will Burke

ryanrbart/RHESSysIOinR documentation built on March 30, 2024, 11:15 p.m.