SubCpars: Subset the cpars slot in an operating model

SubCparsR Documentation

Subset the cpars slot in an operating model

Description

Subset the custom parameters of an operating model by simulation and projection years

Usage

SubCpars(x, ...)

## S4 method for signature 'OM'
SubCpars(x, sims = 1:x@nsim, proyears = x@proyears, silent = FALSE)

## S4 method for signature 'MOM'
SubCpars(x, sims = 1:x@nsim, proyears = x@proyears, silent = FALSE)

Arguments

x

An object of class OM or MOM

...

Arguments for method.

sims

A logical vector of length x@nsim to either retain (TRUE) or remove (FALSE). Alternatively, a numeric vector indicating which simulations (from 1 to nsim) to keep.

proyears

If provided, a numeric to reduce the number of projection years (must be less than x@proyears).

silent

Logical to indicate if messages will be reported to console.

Details

Useful function for running multiMSE in batches if running into memory constraints.

Value

An object of class OM or MOM (same class as x).

Author(s)

T. Carruthers, Q. Huynh

See Also

Sub for MSE objects, SubOM for OM components.


Blue-Matter/MSEtool documentation built on Nov. 7, 2024, 11:38 p.m.