rSW2metrics: Package 'rSW2metrics': Collection of functions to calculate...

rSW2metricsR Documentation

Package rSW2metrics: Collection of functions to calculate ecohydrological metrics from output created by rSOILWAT2 or rSFSW2 simulation experiments.

Description

Collection of functions to calculate ecohydrological metrics from output created by rSOILWAT2 or rSFSW2 simulation experiments.

Details

Recommended setup:

  1. Copy file “Project_Parameters.R”. Specify values for your specific project.

  2. Copy file “Script_to_Extract_Metric.R”. In most cases, this script can be used without changes.

  3. Copy file “Script_Shell_Extracting_rSW2metrics.sh”. Specify arguments/options and select calls to requested metrics.

  4. Run the extraction by executing “Script_Shell_Extracting_rSW2metrics.sh” on the command line.

Example code for copying the three files to your project folder:

file.copy(
  from = list.files(
    path = system.file("exec", package = "rSW2metrics"),
    full.names = TRUE
  ),
  to = PATH_TO_YOUR_PROJECT
)

Notes

The documentation entry metrics describes inputs and outputs and provides a list of available metric functions.

Author(s)

Maintainer: Daniel Schlaepfer danielrschlaepfer@gmail.com (ORCID)

See Also

Useful links:


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