setup_time_simulation_project: Describe the time of a simulation project

In Burke-Lauenroth-Lab/SoilWat_R_Wrapper: Simulation Framework for SOILWAT2

Description

Describe the time of a simulation project

Usage

setup_time_simulation_project(
  sim_time,
  is_idem = FALSE,
  add_st2 = FALSE,
  adjust_NS = FALSE,
  use_doy_range = FALSE,
  doy_ranges = list()
)

Arguments

sim_time	A list with at least values for four named elements: “simstartyr” and “endyr”, one of the following two: “startyr” or “spinup_N”, and dQuotefuture_yrs.
add_st2	A logical value. If TRUE, the output of calling the function simTiming_ForEachUsedTimeUnit is appended to the returned list.
adjust_NS	A logical value. If TRUE, then the result is corrected for locations on the southern vs. northern hemisphere. Only used if add_st2 is TRUE.
use_doy_range	A logical value. If TRUE, then the result is additional daily indices indicating whether the DOY is within the days indicated in the doy_ranges.
doy_ranges	A named list. Aggregation output variables and the daily c(min, max) of days you wish to calculate the aggregation over.
A	named list, i.e., the updated version of sim_time.

See Also

setup_time_simulation_run

Burke-Lauenroth-Lab/SoilWat_R_Wrapper documentation built on Aug. 14, 2020, 5:17 p.m.