read.MFCLFlags: read.MFCLFlags

In robscott3/FLR4MFCL: R Functions for Taming MULTIFAN-CL

read.MFCLFlags

Description

Read flag settings from a par file.

Usage

read.MFCLFlags(parfile, parobj = NULL, first.yr = NA)

Arguments

parfile	A character string giving the name and path of the frq file to be read.
parobj	A character string containing the par file. If parobj is NULL the function uses parfile to read in the par file.
first.yr	The first year of the input data time series (default value NA).

Value

An object of class MFCLFlags.

Note

The traditional way to read in a par file is using read.MFCLPar that imports all parameter values, flags settings, and a variety of other information.

For the purposes of importing flags, read.MFCLFLags can be more practical, being around 20 x faster.

In both cases, the flags() method can be used to access the flags data frame.

Examples

## Not run: 
read.MFCLFlags("C:/R4MFCL/test_data/skj_ref_case/11.par")

## End(Not run)

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