flagMeaning: Flag Meaning

View source: R/flagTools.r

flagMeaningR Documentation

Flag Meaning

Description

Show the meaning of flags, based on a lookup table.

Usage

flagMeaning(flags, flaglist = NULL)

Arguments

flags

MFCL flags from a model run.

flaglist

optional filename to use instead of the built-in ‘flaglist.csv’ lookup table.

Details

The flags object can be any of the following:

  1. folder containing a ⁠par⁠ file

  2. filename of a ⁠par⁠ file

  3. MFCLPar object

  4. MFCLFlags object

  5. data.frame containing flag settings

Value

A data frame with the same columns as flags plus a column called meaning.

See Also

diffFlags calls this function to show the meaning of flags that are different between two model runs.

read.MFCLFlags reads flag settings from a ⁠par⁠ file.

Examples

data(par)
flagMeaning(par)


robscott3/FLR4MFCL documentation built on April 9, 2024, 3:31 p.m.