SP | R Documentation |
A surplus production model that uses only a time-series of catches and a relative abundance index
and coded in TMB. The base model, SP
, is conditioned on catch and estimates a predicted index.
Continuous surplus production and fishing is modeled with sub-annual time steps which should approximate
the behavior of ASPIC (Prager 1994). The Fox model, SP_Fox
, fixes BMSY/K = 0.37 (1/e).
The state-space version, SP_SS
estimates annual deviates in biomass. An option allows for setting a
prior for the intrinsic rate of increase.
The function for the spict
model (Pedersen and Berg, 2016) is available in MSEextra.
SP(
x = 1,
Data,
AddInd = "B",
rescale = "mean1",
start = NULL,
prior = list(),
fix_dep = TRUE,
fix_n = TRUE,
LWT = NULL,
n_seas = 4L,
n_itF = 3L,
Euler_Lotka = 0L,
SR_type = c("BH", "Ricker"),
silent = TRUE,
opt_hess = FALSE,
n_restart = ifelse(opt_hess, 0, 1),
control = list(iter.max = 5000, eval.max = 10000),
...
)
SP_SS(
x = 1,
Data,
AddInd = "B",
rescale = "mean1",
start = NULL,
prior = list(),
fix_dep = TRUE,
fix_n = TRUE,
fix_sigma = TRUE,
fix_tau = TRUE,
LWT = NULL,
early_dev = c("all", "index"),
n_seas = 4L,
n_itF = 3L,
Euler_Lotka = 0L,
SR_type = c("BH", "Ricker"),
integrate = FALSE,
silent = TRUE,
opt_hess = FALSE,
n_restart = ifelse(opt_hess, 0, 1),
control = list(iter.max = 5000, eval.max = 10000),
inner.control = list(),
...
)
SP_Fox(x = 1, Data, ...)
x |
An index for the objects in |
Data |
An object of class Data. |
AddInd |
A vector of integers or character strings indicating the indices to be used in the model. Integers assign the index to the corresponding index in Data@AddInd, "B" (or 0) represents total biomass in Data@Ind, "VB" represents vulnerable biomass in Data@VInd, and "SSB" represents spawning stock biomass in Data@SpInd. |
rescale |
A multiplicative factor that rescales the catch in the assessment model, which
can improve convergence. By default, |
start |
Optional list of starting values. Entries can be expressions that are evaluated in the function. See details. |
prior |
A named list for the parameters of any priors to be added to the model. See details. |
fix_dep |
Logical, whether to fix the initial depletion (ratio of biomass to carrying capacity in the
first year of the model). If |
fix_n |
Logical, whether to fix the exponent of the production function. If |
LWT |
A vector of likelihood weights for each survey. |
n_seas |
Integer, the number of seasons in the model for calculating continuous surplus production. |
n_itF |
Integer, the number of iterations to solve F conditional on the observed catch given multiple seasons within an annual time step.
Ignored if |
Euler_Lotka |
Integer. If greater than zero, the function will calculate a prior for the intrinsic rate of increase to use in the estimation model
(in lieu of an explicit prior in argument |
SR_type |
If |
silent |
Logical, passed to |
opt_hess |
Logical, whether the hessian function will be passed to |
n_restart |
The number of restarts (calls to |
control |
A named list of parameters regarding optimization to be passed to
|
... |
For |
fix_sigma |
Logical, whether the standard deviation of the index is fixed. If |
fix_tau |
Logical, the standard deviation of the biomass deviations is fixed. If |
early_dev |
Character string describing the years for which biomass deviations are estimated in |
integrate |
Logical, whether the likelihood of the model integrates over the likelihood of the biomass deviations (thus, treating it as a state-space variable). |
inner.control |
A named list of arguments for optimization of the random effects, which
is passed on to newton via |
For start
(optional), a named list of starting values of estimates can be provided for:
MSY
Maximum sustainable yield.. Otherwise, 300% of mean catch by default.
FMSY
Steepness. Otherwise, Data@Mort[x]
or 0.2 is used.
dep
Initial depletion (B/B0) in the first year of the model. By default, 1.
n
The production function exponent that determines BMSY/B0. By default, 2 so that BMSY/B0 = 0.5.
sigma
Lognormal SD of the index (observation error). By default, 0.05. Not
used with multiple indices.
tau
Lognormal SD of the biomass deviations (process error) in SP_SS
. By default, 0.1.
Multiple indices are supported in the model.
Tip: to create the Fox model (Fox 1970), just fix n = 1. See example.
An object of Assessment containing objects and output from TMB.
The following priors can be added as a named list, e.g., prior = list(r = c(0.25, 0.15), MSY = c(50, 0.1). For each parameter below, provide a vector of values as described:
r
- A vector of length 2 for the lognormal prior mean (normal space) and SD (lognormal space).
MSY
- A vector of length 2 for the lognormal prior mean (normal space) and SD (lognormal space).
In lieu of an explicit r prior provided by the user, set argument Euler_Lotka = TRUE
to calculate the prior mean and SD using
the Euler-Lotka method (Equation 15a of McAllister et al. 2001).
The Euler-Lotka method is modified to multiply the left-hand side of equation 15a by the alpha parameter of the
stock-recruit relationship (Stanley et al. 2009). Natural mortality and steepness are sampled in order to generate
a prior distribution for r. See vignette("Surplus_production")
for more details.
Model description and equations are available on the openMSE website.
SP
: Cat, Ind
SP_SS
: Cat, Ind
SP_SS
: CV_Ind
The model uses the Fletcher (1978) formulation and is parameterized with FMSY and MSY as leading parameters. The default conditions assume unfished conditions in the first year of the time series and a symmetric production function (n = 2).
Q. Huynh
Fletcher, R. I. 1978. On the restructuring of the Pella-Tomlinson system. Fishery Bulletin 76:515:521.
Fox, W.W. 1970. An exponential surplus-yield model for optimizing exploited fish populations. Transactions of the American Fisheries Society 99:80-88.
McAllister, M.K., Pikitch, E.K., and Babcock, E.A. 2001. Using demographic methods to construct Bayesian priors for the intrinsic rate of increase in the Schaefer model and implications for stock rebuilding. Can. J. Fish. Aquat. Sci. 58: 1871-1890.
Pedersen, M. W. and Berg, C. W. 2017. A stochastic surplus production model in continuous time. Fish and Fisheries. 18:226-243.
Pella, J. J. and Tomlinson, P. K. 1969. A generalized stock production model. Inter-Am. Trop. Tuna Comm., Bull. 13:419-496.
Prager, M. H. 1994. A suite of extensions to a nonequilibrium surplus-production model. Fishery Bulletin 92:374-389.
Stanley, R.D., M. McAllister, P. Starr and N. Olsen. 2009. Stock assessment for bocaccio (Sebastes paucispinis) in British Columbia waters. DFO Can. Sci. Advis. Sec. Res. Doc. 2009/055. xiv + 200 p.
SP_production plot.Assessment summary.Assessment retrospective profile make_MP
data(swordfish)
#### Observation-error surplus production model
res <- SP(Data = swordfish)
# Provide starting values, assume B/K = 0.875 in first year of model
# and symmetrical production curve (n = 2)
start <- list(dep = 0.875, n = 2)
res <- SP(Data = swordfish, start = start)
plot(res)
profile(res, FMSY = seq(0.1, 0.4, 0.01))
retrospective(res)
#### State-space version
res_SS <- SP_SS(Data = swordfish, start = list(dep = 0.875, sigma = 0.1, tau = 0.1))
plot(res_SS)
#### Fox model
res_Fox <- SP(Data = swordfish, start = list(n = 1), fix_n = TRUE)
res_Fox2 <- SP_Fox(Data = swordfish)
#### SP with r prior calculated internally (100 stochastic samples to get prior SD)
res_prior <- SP(Data = SimulatedData, Euler_Lotka = 100)
#### Pass an r prior to the model with mean = 0.35, lognormal sd = 0.10
res_prior2 <- SP(Data = SimulatedData, prior = list(r = c(0.35, 0.10)))
#### Pass MSY prior to the model with mean = 1500, lognormal sd = 0.05
res_prior3 <- SP(Data = SimulatedData, prior = list(MSY = c(1500, 0.05)))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.