Learn R Programming

⚠️There's a newer version (3.7.5) 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:

devtools::install_github("tcarruth/MSEtool", build_vignettes = TRUE)
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

693

Version

2.0.0

License

GPL-3

Maintainer

Tom Carruthers

Last Published

August 6th, 2020

Functions in MSEtool (2.0.0)

CASALpars

Rips MLE estimates from CASAL file structure
HCR_ramp

Linearly ramped harvest control rules
Awatea2OM

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

A Harvest Control Rule using B/BMSY and F/FMSY to adjust TAC or TAE.
HCRlin

Generic linear harvest control rule based on biomass
Albacore_TwoFleet

A two-fleet Albacore operating model
CASAL2OM

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

Delay - Difference Stock Assessment in TMB
Assessment-class

Class-Assessment
HCR_MSY

Harvest control rule to fish at some fraction of maximum sustainable yield
MOM-class

Class 'MOM'
MMSE-class

Class 'MMSE'
HistMICE

Reconstruct historical dynamics
NIL

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

Calculate mahalanobis distance (null and alternative MSEs) and statistical power for all MPs in an MSE
SS2Data

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

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

Find the production parameter based on depletion that produces MSY
diagnostic_AM

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

Calculates mahalanobis distance and rejection of the Null operating model
ResFromRel

Returns Results of a set of MICE relationships
expandHerm

Expand the Herm list in SexPars to a matrix of fractions at age
SRA-class

Class-SRA
ldim

Dimensions of a hierarchical list object
cDD

Continuous Delay-differential assessment model
SS2OM

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

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

Management Strategy Evaluation
iSCAMinds

Combines indices into a single index using linear modelling
iSCAMcomps

Combines all iSCAM age composition data across fleets
fetch.file.names

Reads iSCAM Data, Control and Projection files
getinds

Characterize posterior predictive data
SSS

Simple Stock Synthesis
makemov

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

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

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

Combine data among fleets
compare_models

Compare output from several assessment models
Model-based-MP

Model-based management procedures
getnIVs

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

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

optimize for catchability (q)
SCA

Statistical catch-at-age (SCA) model
plot.prof

Plot profile object
VPA

Virtual population analysis (VPA)
avail

What objects of this class are available
SIL

Slot in list: get the slot values from a list of objects
plot.retro

Methods for retro object
plot.MMSE

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

Plot Assessment object
plot_timeseries

Plot time series of data
popdynOneMICE

Population dynamics for a MICE model (single year)
optQ_multi

Optimize q for a single simulation
plot.MOM

Standard plot for an object of class MOM
read.data.file

Reads iSCAM dat file
plotmulti

A basic SSB plot for debugging runMSE output
read.mcmc

Reads iSCAM mcmc output files
plotquant

A fairly tidy time-series quantile plot
project-class

Class-project
plot_composition

Plot composition data
plot_betavar

Plots a beta variable
popdynMICE

Population dynamics for a MICE model (multiyear)
prelim_AM

Preliminary Assessments in MSE
load.iscam.files

Reads iSCAM files into a hierarchical R list object
plot.SRA

Plot SRA scope output
mahplot

Plot statistical power of the indicator with increasing time blocks
retrospective

Retrospective analysis of assessment models
TEG

Toms expand grid
hrate

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

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

Surplus production model with FMSY and MSY as leading parameters
TAC_MSY

Calculate MSY-based TAC from Assessment object
SOL

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

Combine data among stocks
retrospective_AM

retrospective_AM (retrospective of Assessment model in MSE)
getq_multi_MICE

optimize for catchability (q) and fishing dist for a MICE model
make_MP

Make a custom management procedure (MP)
summary.Assessment

Summary of Assessment object
plot_steepness

Plots probability distribution function of stock-recruit steepness
read.projection.file

Reads iSCAM projection file
plot_lognormalvar

Plots a lognormal variable
plot_crosscorr

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

Reads iSCAM parameter file
plot_residuals

Plot residuals
simmov

Calculates movement matrices from user inputs
plotRel

Plot a relationship between stocks
read.control.file

Reads iSCAM control file
qestMICE

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

North Atlantic Swordfish dataset
prof-class

Class-prof
retro-class

Class-retro
read.report.file

Reads iSCAM Rep file
profile

Profile likelihood of assessment models
plot_SR

Plot stock-recruitment function
projection

Projections for assessment models
userguide

Get the MSEtool vignettes
tinyErr

Remove observation error, process error, implementation error or future gradients in (time varying) parameters