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

704

Version

1.5.0

License

GPL-3

Maintainer

Tom Carruthers

Last Published

March 24th, 2020

Functions in MSEtool (1.5.0)

Awatea2OM

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

Rips MLE estimates from CASAL file structure
Data-rich-MP

Data-rich management procedures
HCR_MSY

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

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

A two-fleet Albacore operating model
DD_TMB

Delay - Difference Stock Assessment in TMB
HCR_ramp

Linearly ramped harvest control rules
CASAL2OM

Reads MLE estimates from CASAL file structure into an operating model
Assessment-class

Class-Assessment
NIL

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

Calculates mahalanobis distance and rejection of the Null operating model
PRBcalc

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

Generic linear harvest control rule based on biomass
ResFromRel

Returns Results of a set of MICE relationships
MPCalcsNAs

Fill any NAs arising from MPCalcs (hermaphroditism mode)
avail

What objects of this class are available
SP

Surplus production model with FMSY and MSY as leading parameters
cDD

Continuous Delay-differential assessment model
SOL

Sum over list: get the list values from a list of lists
SRA-class

Class-SRA
HistMICE

Reconstruct historical dynamics
expandHerm

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

Find the production parameter based on depletion that produces MSY
make_MP

Make a custom management procedure (MP)
makemov

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

Reads data from iSCAM file structure into a DLMtool Data object
MMSE-class

Class 'MMSE'
plot_lognormalvar

Plots a lognormal variable
TAC_MSY

Calculate MSY-based TAC from Assessment object
fetch.file.names

Reads iSCAM Data, Control and Projection files
MSEtool-package

Management Strategy Evaluation
SS2OM

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

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

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

Toms expand grid
SCA

Statistical catch-at-age (SCA) model
VPA

Virtual population analysis (VPA)
iSCAMinds

Combines indices into a single index using linear modelling
getinds

Characterize posterior predictive data
hrate

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

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

Dimensions of a hierarchical list object
compare_models

Compare output from several assessment models
iSCAM2OM

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

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

Plot residuals
MOM-class

Class 'MOM'
load.iscam.files

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

Plot Assessment object
iSCAMcomps

Combines all iSCAM age composition data across fleets
optQ_multi

Optimize q for a single simulation
mahplot

Plot statistical power of the indicator with increasing time blocks
plotRel

Plot a relationship between stocks
plot.retro

Methods for retro object
multiData

Combine data among fleets
multiDataS

Combine data among stocks
plotmulti

A basic SSB plot for debugging runMSE output
plot.SRA

Plot SRA scope output
plotquant

A fairly tidy time-series quantile plot
plot_timeseries

Plot time series of data
plot_steepness

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

Reads iSCAM control file
plot.prof

Plot profile object
prof-class

Class-prof
prelim_AM

Preliminary Assessments in MSE
projection

Projections for assessment models
plot.MOM

Standard plot for an object of class MOM
getnIVs

Count independent variables for a MICE relationship at position x in a Rel list
plot.MMSE

Standard plot for an object of class MMSE (multi MSE)
read.data.file

Reads iSCAM dat file
getq_multi_MICE

optimize for catchability (q) and fishing dist for a MICE model
retro-class

Class-retro
retrospective_AM

retrospective_AM (retrospective of Assessment model in MSE)
plot_composition

Plot composition data
simmov

Calculates movement matrices from user inputs
retrospective

Retrospective analysis of assessment models
multiMSE

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

Produce a cross-correlation plot of the derived data arising from getinds(MSE_object)
popdynMICE

Population dynamics for a MICE model (multiyear)
getq_multi

optimize for catchability (q)
plot_SR

Plot stock-recruitment function
read.projection.file

Reads iSCAM projection file
multidebug

A basic comparison of runMSE output (MSE) and multiMSE (MMSE)
read.report.file

Reads iSCAM Rep file
summary.Assessment

Summary of Assessment object
plot_betavar

Plots a beta variable
profile

Profile likelihood of assessment models
project-class

Class-project
swordfish

North Atlantic Swordfish dataset
qestMICE

Internal function for optimizing catchability (q) for a MICE model
read.mcmc

Reads iSCAM mcmc output files
read.par.file

Reads iSCAM parameter file
userguide

Get the MSEtool vignettes
popdynOneMICE

Population dynamics for a MICE model (single year)
tinyErr

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