Learn R Programming

⚠️There's a newer version (3.7.4) of this package.Take me there.

MSEtool

MSEtool is an extension of the DLMtool R package and provides simulation tools for management strategy evaluation informing data-rich fisheries.

Find more information about DLMtool and MSEtool at http://datalimitedtoolkit.org/.

Installation

The released version of MSEtool can be downloaded from CRAN:

install.packages("MSEtool")

The GitHub repository contains the development version of MSEtool, which can be installed via:

devtools::install_github("tcarruth/MSEtool")

The development version may be unstable and it is typically not recommended for analyses.

User Guide

Vignettes describing the features of MSEtool can be obtained via:

browseVignettes("MSEtool")

The vignettes can also be viewed on the MSEtool page on CRAN.

A User Guide for the DLMtool package also available at https://dlmtool.github.io/DLMtool/userguide/introduction.html.

Bugs and Issues

Please report any bugs or issues through GitHub or the DLMtool website.

Copy Link

Version

Install

install.packages('MSEtool')

Monthly Downloads

459

Version

1.3.0

License

GPL-3

Maintainer

Tom Carruthers

Last Published

October 1st, 2019

Functions in MSEtool (1.3.0)

HCR_MSY

Harvest control rule to fish at some fraction of maximum sustainable yield
MPCalcsNAs

Fill any NAs arising from MPCalcs (hermaphroditism mode)
MSEtool-package

Management Strategy Evaluation
CASAL2OM

Reads MLE estimates from CASAL file structure into an operating model
Awatea2OM

Reads MCMC estimates from Awatea (Paul Starr) processed r file structure into an operating model
Probs

Calculates mahalanobis distance and rejection of the Null operating model
SCA

Statistical catch-at-age (SCA) model
ResFromRel

Returns Results of a set of MICE relationships
SS2OM

Reads MLE estimates from Stock Synthesis file structure into an operating model using package r4ss.
TAC_MSY

Calculate MSY-based TAC from Assessment object
SIL

Slot in list: get the slot values from a list of objects
hrate

Derives the rate of exchange from one sex to another based on asymptotic fraction
diagnostic_AM

diagnostic_AM (diagnostic of Assessments in MSE): Did Assess models converge during MSE?
compare_models

Compare output from several assessment models
iSCAM2Data

Reads data from iSCAM file structure into a DLMtool Data object
getq_multi

optimize for catchability (q)
Albacore_TwoFleet

A two-fleet Albacore operating model
make_MP

Make a custom management procedure (MP)
getnIVs

Count independent variables for a MICE relationship at position x in a Rel list
HCR_FB

A Harvest Control Rule using B/BMSY and F/FMSY to adjust TAC or TAE.
Data-rich-MP

Data-rich management procedures
HistMICE

Reconstruct historical dynamics
getinds

Characterize posterior predictive data
HCRlin

Generic linear harvest control rule based on biomass
getq_multi_MICE

optimize for catchability (q) and fishing dist for a MICE model
plot.SRA

Plot SRA scope output
plot.prof

Plot profile object
ldim

Dimensions of a hierarchical list object
iSCAMinds

Combines indices into a single index using linear modelling
plot_SR

Plot stock-recruitment function
multiMSE

Run a multi-fleet multi-stock Management Strategy Evaluation
plot_steepness

Plots probability distribution function of stock-recruit steepness
read.mcmc

Reads iSCAM mcmc output files
plot_betavar

Plots a beta variable
multidebug

A basic comparison of runMSE output (MSE) and multiMSE (MMSE)
plot_timeseries

Plot time series of data
read.par.file

Reads iSCAM parameter file
Assessment-class

Class-Assessment
makemov

Calculates movement matrices from user inputs for fraction in each area (fracs) and probability of staying in areas (prob)
read.projection.file

Reads iSCAM projection file
profile

Profile likelihood of assessment models
qestMICE

Internal function for optimizing catchability (q) for a MICE model
SP_production

Find the production parameter based on depletion that produces MSY
MMSE-class

Class 'MMSE'
MOM-class

Class 'MOM'
SRA-class

Class-SRA
TEG

Toms expand grid
prelim_AM

Preliminary Assessments in MSE
prof-class

Class-prof
DD_TMB

Delay - Difference Stock Assessment in TMB
CASALpars

Rips MLE estimates from CASAL file structure
VPA

Virtual population analysis (VPA)
iSCAM2OM

Reads MLE estimates from iSCAM file structure into an operating model
iSCAMcomps

Combines all iSCAM age composition data across fleets
plot_residuals

Plot residuals
multiData

Combine data among fleets
SOL

Sum over list: get the list values from a list of lists
multiDataS

Combine data among stocks
plot_lognormalvar

Plots a lognormal variable
SP

Surplus production model with FMSY and MSY as leading parameters
avail

What objects of this class are available
read.control.file

Reads iSCAM control file
popdynOneMICE

Population dynamics for a MICE model (single year)
popdynMICE

Population dynamics for a MICE model (multiyear)
summary.Assessment

Summary of Assessment object
swordfish

North Atlantic Swordfish dataset
load.iscam.files

Reads iSCAM files into a hierarchical R list object
cDD

Continuous Delay-differential assessment model
mahplot

Plot statistical power of the indicator with increasing time blocks
tinyErr

Remove observation error, process error, implementation error or future gradients in (time varying) parameters
read.data.file

Reads iSCAM dat file
userguide

Get the MSEtool vignettes
expandHerm

Expand the Herm list in SexPars to a matrix of fractions at age
NIL

Item in list: get the list values from a list of lists
SS2Data

Reads data Stock Synthesis file structure into a Data object using package r4ss
SRA_scope

Stock-reduction analysis (SRA) for conditioning operating models
PRBcalc

Calculate mahalanobis distance (null and alternative MSEs) and statistical power for all MPs in an MSE
read.report.file

Reads iSCAM Rep file
plot.MOM

Standard plot for an object of class MOM
plot.MMSE

Standard plot for an object of class MMSE (multi MSE)
plot_composition

Plot composition data
plot_crosscorr

Produce a cross-correlation plot of the derived data arising from getinds(MSE_object)
fetch.file.names

Reads iSCAM Data, Control and Projection files
plotmulti

A basic SSB plot for debugging runMSE output
plotquant

A fairly tidy time-series quantile plot
optQ_multi

Optimize q for a single simulation
plot.Assessment

Plot Assessment object
retrospective_AM

retrospective_AM (retrospective of Assessment model in MSE)
simmov

Calculates movement matrices from user inputs
plotRel

Plot a relationship between stocks
retro-class

Class-retro
plot.retro

Methods for retro object
retrospective

Retrospective analysis of assessment models
HCR_ramp

Linearly ramped harvest control rules