build_output_filter: build_output_filter

In ryanrbart/RHESSysIOinR: Tools for Running RHESSys from R

build_output_filter

Description

Creates a single output filter in R list format. This can be combined with other filters and/or written to file to be read by RHESSys when running.

Usage

build_output_filter(
  timestep = c("daily", "monthly", "annual", "hourly"),
  output_format = c("csv", "netcdf"),
  output_path,
  output_filename,
  spatial_level = c("basin", "hillslope", "zone", "patch", "stratum"),
  spatial_ID,
  variables
)

Arguments

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.