sspm1.0.3 package

Spatial Surplus Production Model Framework for Northern Shrimp Populations

accessors-methods-discret_method

Accessing OR replacing discretization_method model elements

accessors-methods-sspm_boundary

Accessing OR replacing sspm_boundary model elements

accessors-methods-sspm_dataset

Accessing OR replacing sspm_dataset model elements

accessors-methods-sspm_fit

Accessing OR replacing sspm_fit model elements

accessors-methods-sspm_formula

Accessing OR replacing sspm_formula model elements

as_discretization_method

Cast into a discretization_method object

discretization_method-class

sspm discretization method class

extract-methods

Extract methods

fit

Fit the GAM part of a sspm model

intervals

GAM confidence and prediction intervals

sspm-accessors-methods

Accessing OR replacing sspm model elements

sspm-class

sspm model class

sspm-constructor

Create a sspm model object

sspm_formula-class

sspm formula object

map_formula

Map model formula onto a sspm_dataset object

pipe

Pipe operator

plot

Plot sspm objects

predict

Predict with a SPM model

smooths

sspm Smoothing functions

spm_aggregate_catch

Update biomass value from catch adta

spm_aggregate

Aggregate a dataset or fit data variable based on a boundary

spm_as_boundary

Create a sspm_boundary object

spm_as_dataset

Create a sspm_dataset dataset structure

spm_discretize

Discretize a sspm model object

spm_lag

Create lagged columns in a sspm smoothed data slot

spm_methods

Get the list of available discretization methods

spm_smooth_methods

Get the list of available smoothing methods

spm_smooth

Smooth a variable in a sspm dataset

spm_split

Split data in test and train sets

spm

Fit an SPM model

sspm_boundary-class

sspm boundary structure

sspm_dataset-class

sspm dataset structure

sspm_discrete_boundary-class

sspm discrete boundary structure

sspm_fit-class

sspm fit

sspm-package

sspm: Spatial Surplus Production Model Framework for Northern Shrimp P...

summary

Summarises sspm_fit objects

tesselate_voronoi

Perform voronoi tesselation

triangulate_delaunay

Perform delaunay triangulation

Implement a GAM-based (Generalized Additive Models) spatial surplus production model (spatial SPM), aimed at modeling northern shrimp population in Atlantic Canada but potentially to any stock in any location. The package is opinionated in its implementation of SPMs as it internally makes the choice to use penalized spatial gams with time lags. However, it also aims to provide options for the user to customize their model. The methods are described in Pedersen et al. (2022, <https://www.dfo-mpo.gc.ca/csas-sccs/Publications/ResDocs-DocRech/2022/2022_062-eng.html>).

  • Maintainer: Valentin Lucet
  • License: MIT + file LICENSE
  • Last published: 2025-02-12