IOin_tec_all_options: IOin_tec_all_options

View source: R/IOin_tec_all_options.R

IOin_tec_all_optionsR Documentation

IOin_tec_all_options

Description

Generic input function to construct a dataframe for all possible RHESSys temporal event control (TEC) commands except csv commands. The function is flexible, allowing the user to construct complex tec files. However, due to the number of potential combinations of tec events, there are few checks on appropriateness of tec event sequences (for example, turning off a tec event before it is turned on). Full list of tec commands in RHESSys is available at init/construct_tec.c

Usage

IOin_tec_all_options(
  print_hourly_on = NULL,
  print_hourly_growth_on = NULL,
  print_hourly_off = NULL,
  print_hourly_growth_off = NULL,
  print_daily_on = NULL,
  print_daily_growth_on = NULL,
  print_daily_off = NULL,
  print_daily_growth_off = NULL,
  print_monthly_on = NULL,
  print_monthly_off = NULL,
  print_yearly_on = NULL,
  print_yearly_growth_on = NULL,
  print_yearly_off = NULL,
  print_yearly_growth_off = NULL,
  redefine_strata = NULL,
  redefine_world = NULL,
  redefine_world_multiplier = NULL,
  redefine_world_thin_remain = NULL,
  redefine_world_thin_harvest = NULL,
  redefine_world_thin_snags = NULL,
  roads_on = NULL,
  roads_off = NULL,
  output_current_state = NULL
)

Arguments

print_hourly_on

Start printing hourly output data

print_hourly_growth_on

Start printing hourly carbon-related output data

print_hourly_off

Stop printing hourly output data

print_hourly_growth_off

Stop printing hourly carbon-related output data

print_daily_on

Start printing daily output data

print_daily_growth_on

Start printing daily carbon-related output data

print_daily_off

Stop printing daily output data

print_daily_growth_off

Stop printing daily carbon-related output data

print_monthly_on

Start printing monthly output data

print_monthly_off

Stop printing monthly output data

print_yearly_on

Start printing yearly output data

print_yearly_growth_on

Start printing yearly carbon-related output data

print_yearly_off

Stop printing yearly output data

print_yearly_growth_off

Stop printing yearly carbon-related output data

redefine_strata

Redefine strata based on a file

redefine_world

Redefine world based on a file

redefine_world_multiplier

Redefine world based on a multiplier of existing worldfile values

redefine_world_thin_remain

Redefine world based on a thinning event where removed vegetation is transferred to CWD and litter stores

redefine_world_thin_harvest

Redefine world based on a thinning event where removed vegetation exits watershed

redefine_world_thin_snags

Redefine world based on a thinning event where stems are left in place.

roads_on

Start processing roads

roads_off

Stop processing roads

output_current_state

Output worldfile

Note

All arguments accept a date or vector of dates in the format of "year month day hour" e.g. c("2000 10 1 1", "2001 9 30 1").

For more information on redefine worlds, see wiki page Redefining-the-worldfile

Author(s)

Ryan R Bart


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