inputcollectors: End-user functions that collect a specific 'input'

inputcollectorsR Documentation

End-user functions that collect a specific input

Description

These functions have a name that starts with collect_input_. They have at least the following arguments: path, name_sw2_run, zipped_runs, and ....

Arguments

path

A character string. The path to the simulation project folder that contains the individual folder of each simulated site.

name_sw2_run

A character string. The name of the folder (or zip archive, see zipped_runs) of the simulated site for which metrics are to be calculated. rSOILWAT2 input and output is organized following conventions of rSFSW2, i.e., inputs for each scenario are stored in a list object named “swRunScenariosData” which is stored on disk as a file “sw_input.RData”; and output data is stored for each scenario separately in an object named “runDataSC” in a file “sw_output_scX.RData” where X is the number of the scenario.

zipped_runs

A logical value. Describes whether name_sw2_run is a zip archive or a regular folder.

id_scen

An integer value. The scenario number for which input values are to be collected.

...

Additional arguments.

List of currently available input collectors:

  • collect_input_soillayers_clay

  • collect_input_soillayers_count

  • collect_input_soillayers_depth

  • collect_input_soillayers_gravel

  • collect_input_soillayers_sand


DrylandEcology/rSW2metrics documentation built on May 25, 2023, 10:38 a.m.