read.MFCLPar: read.MFCLPar

In PacificCommunity/ofp-sam-flr4mfcl: R Functions for Taming MULTIFAN-CL

read.MFCLPar

Description

Read information from the par file.

Usage

read.MFCLPar(parfile, first.yr = NA)

Arguments

parfile	A character string giving the name and path of the frq file to be read.
first.yr	The first year of the input data time series (default value NA).

Details

The first.yr argument is ignored when reading par files from MFCL version 2.2.2.0 (2023-07-07) and later, since the correct first year is now embedded in the par file.

For older par files that do not contain the first year, the user is required to pass an appropriate value as first.yr. The firstYear function can be helpful when working with old model runs.

Value

An object of class MFCLPar.

See Also

read.MFCLFlags, firstYear.

Examples

## Not run: 
read.MFCLPar("yft/2020/11.par", first.yr=1952)  # old MFCL, must specify year
read.MFCLPar("yft/2023/11.par")                 # new MFCL, automatic year

## End(Not run)

PacificCommunity/ofp-sam-flr4mfcl documentation built on April 8, 2024, 6:47 p.m.