SAMtool1.9.1 package

Stock Assessment Methods Toolkit

Assessment-class

Class-Assessment

cDD

Continuous Delay-differential assessment model

compare_models

Compare output from several assessment models

DD_TMB

Delay - Difference Stock Assessment in TMB

diagnostic

Diagnostic of assessments in MSE: did Assess models converge during MS...

getinds

Characterize posterior predictive data

HCR_escapement

Fixed escapement harvest control rule

HCR_FB

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

HCR_fixedF

Simple fixed F harvest control rule

HCR_MSY

Harvest control rule to fish at some fraction of maximum sustainable y...

HCR_ramp

Linearly ramped harvest control rules

HCR_segment

Segmented harvest control rules

HCRlin

Generic linear harvest control rule based on biomass

mahplot

Plot statistical power of the indicator with increasing time blocks

make_MP

Make a custom management procedure (MP)

Model-based-MP

Model-based management procedures

plot_betavar

Plots a beta variable

plot_composition

Plot composition data

plot_crosscorr

Produce a cross-correlation plot of the derived data arising from geti...

plot_lognormalvar

Plots a lognormal variable

plot_residuals

Plot residuals

plot_SR

Plot stock-recruitment function

plot_steepness

Plots probability distribution function of stock-recruit steepness

plot_timeseries

Plot time series of data

plot.Assessment

Plot Assessment object

plot.prof

Plot profile object

plot.RCModel

Plot RCM scope output

plot.retro

Methods for retro object

posterior

Sample posterior of TMB models in SAMtool

PRBcalc

Calculate mahalanobis distance (null and alternative MSEs) and statist...

prelim_AM

Preliminary Assessments in MSE

Probs

Calculates mahalanobis distance and rejection of the Null operating mo...

prof-class

Class-prof

profile

Profile likelihood of assessment models

project-class

Class-project

projection

Projections for assessment models

RCM_assess

The rapid conditioning model as an assessment function

RCM

Rapid Conditioning Model (RCM)

RCM2MOM

Convert RCM to a multi-fleet operating model (MOM)

RCMdata-class

Class-RCMdata

RCModel-class

Class-RCModel

retro-class

Class-retro

retrospective_AM

retrospective_AM (retrospective of Assessment model in MSE)

retrospective

Retrospective analysis of assessment models

SAMtool-package

Stock Assessment Methods Toolkit

SCA_CAL

Age-structured model using fishery length composition

SCA_DDM

SCA models with time-varying natural mortality

SCA_RWM

SCA with random walk in M

SCA

Statistical catch-at-age (SCA) model

Shortcut

Assessment emulator as a shortcut to model fitting in closed-loop simu...

sim-class

Class-sim

simulate

Generate simulated data from TMB models in SAMtool

SP_production

Find the production parameter based on depletion that produces MSY

SP

Surplus production model with FMSY and MSY as leading parameters

SSS

Simple Stock Synthesis

summary.Assessment

Summary of Assessment object

TAC_MSY

Calculate MSY-based TAC from Assessment object

userguide

Get the SAMtool vignettes

VPA

Virtual population analysis (VPA)

Simulation tools for closed-loop simulation are provided for the 'MSEtool' operating model to inform data-rich fisheries. 'SAMtool' provides a conditioning model, assessment models of varying complexity with standardized reporting, model-based management procedures, and diagnostic tools for evaluating assessments inside closed-loop simulation.

  • Maintainer: Quang Huynh
  • License: GPL-3
  • Last published: 2026-01-15