atlantis_fgrpon: Test if functional groups is active.

View source: R/atlantisfmsy_check.R

atlantis_fgrponR Documentation

Test if functional groups is active.

Description

Test if the functional group func_grp is active in the calibrated model. It open the functional groups csv parameters file and look if the functional group is on.

Usage

atlantis_fgrpon(func_grp, path, exe_name, batch_file = NULL)

Arguments

func_grp

The code of the Atlantis functional group for which Fmsy will be estimated.

path

The directory of the batch or shell file.

exe_name

The name of the atlantis executable you used (ex: atlantismain, atlantisNew).

batch_file

The name of the batch/shell file with extension you are using to run your model. If not provided, the function will search for the unique batch file in your folder_path. Default: NULL.

Value

fgrpon A binary variable telling if the functional group is (1) activated or not (0).

See Also

atlantis_paraselect for parameters file selection, and read.table to open table stored in text files (.txt, .csv ...).

Examples

atlantis_fgrpon("COD", "C:/Atlantis/AtlantisEEC/AtlantisEECF_v3",
                "atlantismain", "runAtlantis.bat")
atlantis_fgrpon("COD", "/home/Atlantis/AtlantisEEC/AtlantisEECF_v3",
                "atlantisNew", "runAtlantis.sh")


rgirardi/atlantisfmsy documentation built on Aug. 30, 2022, 9:11 a.m.