checkMSE: Utility functions for MSE objects

In DLMtool/DLMtool: Data-Limited Methods Toolkit

Description

Utility functions for MSE objects

Usage

checkMSE(MSEobj)

joinMSE(MSEobjs = NULL)

addMPs(MSEobjs)

updateMSE(MSEobj)

Arguments

MSEobj	A MSE object. For updateMSE, a MSE object from a previous version of DLMtool. Also works with Stock, Fleet, Obs, Imp, and Data objects.
MSEobjs	A list of MSE objects. Must all have identical operating model and MPs. MPs which don't appear in all MSE objects will be dropped.

Value

An object of class MSE

Functions

• checkMSE: Check that an MSE object includes all slots in the latest version of DLMtool Use updateMSE to update the MSE object

• joinMSE: Joins two or more MSE objects together. MSE objects must have identical number of historical years, and projection years. Also works for Hist objects returned by runMSE(Hist=TRUE)

• addMPs: Adds additional MPs to an MSE object by combining multiple MSE objects that have identical historical OM values but different MPs. Note that the Misc slot is returned as a list of length(MSEobjs) with each element containing the Misc object from MSEobjs.

• updateMSE: Updates an existing MSE object (class MSE) from a previous version of the DLMtool to include slots new to the lastest version. Also works with Stock, Fleet, Obs, Imp, and Data objects. The new slots will be empty, but avoids the 'slot doesn't exist' error that sometimes occurs. Returns an object of class matching class(MSEobj)

Author(s)

A. Hordyk

Examples

# An example of joinMSE
## Not run: 
OM1 <- DLMtool::testOM
MSE1 <- runMSE(OM1) 
OM2 <- OM1 
OM2@seed <- OM1@seed + 1
MSE2 <- runMSE(OM2)
MSE <- joinMSE(list(MSE1, MSE2))
MSE@nsim

## End(Not run)

DLMtool/DLMtool documentation built on June 20, 2021, 5:20 p.m.