Package: Rceattle 5.66.1

Grant Adams

Rceattle: Fits the Multispecies Assessment Model (CEATTLE) Using TMB

Implements the CEATTLE model using Template Model Builder ('TMB'; Kristensen et al. 2015), which can be installed following <https://github.com/kaskr/adcomp/wiki/Download>. Structured similar to the original manuscript in terms of modularization. Separate functions estimate retrospective temperature- and size-specific predator rations, prey preference, and weight-at-age. These are then used as inputs to the CEATTLE model to evaluate how predation mortality, recruitment, and survival of three target species change under historical climate conditions and harvest rates.

Authors:Grant Adams [aut, cre]

Rceattle_5.66.1.tar.gz
Rceattle_5.66.1.zip(r-4.7-x86_64)Rceattle_5.66.1.zip(r-4.7-arm64)Rceattle_5.66.1.zip(r-4.6-x86_64)Rceattle_5.66.1.zip(r-4.6-arm64)Rceattle_5.66.1.zip(r-4.5-x86_64)
Rceattle_5.66.1.tgz(r-4.6-x86_64)Rceattle_5.66.1.tgz(r-4.6-arm64)Rceattle_5.66.1.tgz(r-4.5-x86_64)Rceattle_5.66.1.tgz(r-4.5-arm64)
Rceattle_5.66.1.tar.gz(r-4.7-arm64)Rceattle_5.66.1.tar.gz(r-4.7-x86_64)Rceattle_5.66.1.tar.gz(r-4.6-arm64)Rceattle_5.66.1.tar.gz(r-4.6-x86_64)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
Rceattle/json (API)

# Install 'Rceattle' in R:
install.packages('Rceattle', repos = c('https://noaa-fisheries-integrated-toolbox.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/afsc-assessments/rceattle/issues

Pkgdown/docs site:https://afsc-assessments.github.io

Datasets:
  • Atka2022 - Data inputs for Atka mackerel CEATTLE model
  • BS2017MS - Data inputs for multispecies CEATTLE of the Bering Sea from 1979 to 2017
  • BS2017SS - Data inputs for single species CEATTLE of the Bering Sea from 1979 to 2017
  • EBS_ms_run - Fitted multispecies CEATTLE model for the Eastern Bering Sea
  • EBS_ss_M_run - Fitted single-species CEATTLE model with estimated M for the Eastern Bering Sea
  • EBS_ss_run - Fitted single-species CEATTLE model for the Eastern Bering Sea
  • GeorgesBank3spp - Data inputs for a three-species Georges Bank CEATTLE model
  • GOA2018SS - Data inputs for a single-species Gulf of Alaska CEATTLE model
  • GOAatf - Data inputs for Gulf of Alaska arrowtooth flounder CEATTLE model
  • GOAatf2023 - Data inputs for Gulf of Alaska arrowtooth flounder CEATTLE model
  • GOAcod - Data inputs for Gulf of Alaska Pacific cod CEATTLE model
  • GOApollock - Data inputs for Gulf of Alaska walleye pollock CEATTLE model
  • GOAsafe2018 - Gulf of Alaska 2018 SAFE report reference values
  • NorthernRockfish2022 - Data inputs for Northern Rockfish CEATTLE model
  • whamGrowthData - Data inputs for CEATTLE model with WHAM-estimated growth

On CRAN:

Conda:

8.21 score 12 stars 275 scripts 91 exports 52 dependencies

Last updated from:2b86271b70. Checks:8 OK, 6 WARNING, 1 FAIL. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-arm64OK471
linux-devel-x86_64OK602
source / vignettesOK772
linux-release-arm64OK575
linux-release-x86_64OK706
macos-release-arm64WARNING668
macos-release-x86_64WARNING1122
macos-oldrel-arm64WARNING432
macos-oldrel-x86_64WARNING754
windows-devel-arm64WARNING589
windows-devel-x86_64OK714
windows-release-arm64WARNING576
windows-release-x86_64OK579
windows-oldrel-x86_64OK667
wasm-releaseFAIL342

Exports:build_boundsbuild_catchabilitybuild_compositionbuild_databuild_growthbuild_hcrbuild_hcr_mapbuild_M1build_mapbuild_paramsbuild_selectivitybuild_srrcheck_mseclean_datacombine_datacompare_simconvergence_diagnosticsdata_requirementsfit_controlfit_modjitterlinkage_specload_configload_msemodel_averagemodel_configmse_summaryosa_diagnosticsosa_residualsparameter_dictionaryparameter_indexplot_b_eatenplot_b_eaten_propplot_biomassplot_catchplot_catchabilityplot_compplot_dataplot_depletionplot_depletionSSBplot_diet_compplot_diet_comp1plot_diet_comp2plot_exploitable_biomassplot_fplot_formplot_indexplot_index_residualplot_indexresidualplot_logindexplot_m_at_ageplot_m2_at_age_propplot_maturityplot_mortalityplot_profileplot_rationplot_recruitmentplot_selectivityplot_selectivity_vs_maturityplot_ssbplot_ssb_depletionplot_stock_recruitplot_timeseriesprior_betaprior_gammaprior_lognormalprior_normalprocess_residualsprofile_componentsquantity_dictionaryread_datarearrange_datrearrange_dataremove_Frename_outputreport_tablesretrospectivereweight_compsrun_configrun_msesample_recsave_configself_testset_phasessim_modstandard_outputswitch_checkTMBAICTMBphasewrite_datawrite_template

Dependencies:cellrangerclicowplotcpp11crayondplyrfarvergenericsggplot2gluegtablehmsisobandlabelinglatticelifecyclemagrittrMASSMatrixpillarpkgconfigplyrprettyunitsprogresspurrrR.methodsS3R.ooR.utilsR6rbibutilsRColorBrewerRcppRcppEigenRdpackreadxlreformulasrematchrlangS7scalesstringistringrtibbletidyrtidyselectTMButf8vctrsviridisLitewithrwritexlyaml

Model options and functionality
1. Model dimensions and operating mode | msmMode, single-species vs. multi-species | initMode, initial age structure | The initial equilibrium catch | estimateMode, what does fit_mod() actually do? | Random-effects toggles | 2. Predation: suitMode (per predator) | 3. Selectivity (per fleet) | Sharing a selectivity between fleets | Sex structure and relative selectivity | Which forms can hold a sex difference in level | 4. Catchability (per fleet) | Index likelihood (Index_distribution) | Which fleets get a catchability | How an index is timed against mortality | A snapshot-timed index on a fishery's selectivity | 5. Composition likelihoods | Ageing error, per fleet | 6. Recruitment / stock-recruit (recFun = build_srr()) | 7. Natural mortality (M1Fun = build_M1()) | M1_model, fixed-effects structure of M1 | M1_re, random-effects structure on M1 | 8. Growth and weight-at-age (growthFun = build_growth()) | growth_model, fixed-effects structure of growth | Growth variability, plus group, length bins and maturity | 9. Harvest control rules (HCR = build_hcr()) | 10. Projection and MSE | 11. Diagnostics and inference | 12. Plotting | References

Last update: 2026-10-26
Started: 2026-05-08

Model diagnostics
Setup and plotting data | S3 Methods | Convergence diagnostics | Naming the parameter, not just the block | Fit plots | Composition data | Survey indices | Catch | One-step-ahead (OSA) residuals | Choosing the one-step-ahead method | With random effects, the choice reverses for the aggregate series | Fleets with tail accumulation | Process residuals | Retrospective analysis | Jitter testing | Self-test (simulation–estimation) | Redrawing process error | Likelihood profile | Moving a set of cells together | Catchability | Where the data disagree | Comparing runs | Collecting it into report tables | Model average

Last update: 2026-10-26
Started: 2026-05-08

Model parameterizations
In progress! | Population dynamics | Predation sub-model | Suitability | MSVPA Type 2 based suitability | Predation mortality | Single-species mode | MSVPA Type 2 based predation mortality | MSVPA Type 3 based predation mortality | Consumption | Bioenergetics based ration | Input ration-at-age | Fishery and survey observation model | Selectivity parameterizations | Selectivity penalty weights | Fixed selectivity | Non-parametric (Type 1) | Logistic | Time-varying logistic | Double logistic | Time-varying double logistic 1 (ascending and descending time-varying parameters) | Time-varying double logistic 2 (random walk ascending-time varying parameters) | Descending logistic | Time-varying descending logistic | Non-parametric (Type 2) | Time-varying non-parametric (Type 2 for hake) | Catchability parameterizations | Linear time-invariant catchability formulations | Time-varying catchability formulations

Last update: 2026-10-26
Started: 2026-05-08

Environmental linkages and priors
Overview | A first example: temperature on K | The linkage_spec() API | Priors | Putting a prior on the parameter itself | Growth SD endpoints | Species- and (species, sex)-specific priors | Per-species formulas | Per-sex formulas | Polynomial and basis-expansion formulas | Time blocks | How the pieces fit together | Natural mortality | Recruitment | Priors and fixed values on R0, alpha and beta | Catchability | A prior on the survey catchability | Selectivity | Data weighting (Dirichlet-multinomial) | A multi-process example | Inspecting and debugging | Behind the scenes: automatic base-parameter handling | init and the base parameter | Stratification | Single-sex models and by = ~ ... + sex | Random effects | Integrated or penalized | Current limitations | See also

Last update: 2026-10-26
Started: 2026-05-08

Rceattle: An Introduction
Overview | 1. Installation | 2. Data | 3. Fit models | 4. Reading the fitted object | 5. Compare models | 6. Model plots and diagnostics

Last update: 2026-10-16
Started: 2026-05-08

HCRs and MSEs: an introduction
Fitting the operating model | Fitting the estimation model (Tier 3 HCR) | Running the MSE | Check endyr before you start | Reproducibility | Evaluating the MSE with plots | Summary statistics | Alternative scenarios | Different reference points | Triennial bottom-trawl survey | 4-year assessment cycle and reduced survey coverage | A missed assessment, and a buffer while advice is stale | Climate-linked MSE | Climate-linked OM | Run MSE | Overall summary

Last update: 2026-10-16
Started: 2026-05-08

Single- vs. multi-species models
When to use each mode | Bering Sea example | Gulf of Alaska example | Predator-prey suitability (suitMode) | Comparing outputs

Last update: 2026-10-16
Started: 2026-05-08

Building a data object in R
The quick path: build_data() | Which inputs does my model need? | Building the list by hand | Setup | 1. Species / model controls | 2. Fleet control table | 3. Survey index data | 4. Catch data | 5. Composition data (optional) | 6. Conditional age-at-length (CAAL) data (optional) | 7. Biological inputs | Age-to-length transition matrix | Ageing error matrix | Weight-at-age | Maturity-at-age | Sex ratio at age | Fixed selectivity (optional) | Fixed numbers-at-age (optional) | Natural mortality (M1 base) | Environmental covariate data (optional) | 8. Multi-species bioenergetics parameters (optional in single-species mode) | 9. Validate and fit | 10. Export back to Excel (optional) | 11. Persist and share a run configuration (optional)

Last update: 2026-10-16
Started: 2026-05-08

Converting from Stock Synthesis
Model controls | Fleets | Catch data | Survey indices | Composition data | Ageing error | Weight-at-age | Other inputs | Verifying the conversion against SS | See also

Last update: 2026-10-16
Started: 2026-05-08

Projections and reference points
Setup | Fixed-F projections | Recruitment in the projection period | Manual recruitment deviations | Stochastic recruitment via sample_rec() | Comparing projection scenarios | Random recruitment effects | Available harvest control rules

Last update: 2026-10-04
Started: 2026-05-08

Growth estimation with linkages and priors
Overview | Load data and inspect the growth dataset | Build a growth model with linkages | What this linkage does | Time-varying growth | Fit the model | Inspect the linkage table and prior contributions | Compare with an unlinked baseline model and Richards model | Matching a Stock Synthesis growth specification | Notes on priors through linkages

Last update: 2026-10-04
Started: 2026-05-08

Readme and manuals

Help Manual

Help pageTopics
Helper to adjust map for shared catchability/selectivity indicesadjust_map_shared_params
Tidy long-format derived quantities from an Rceattle fitas.data.frame.Rceattle
Data inputs for Atka mackerel CEATTLE model (2022)Atka2022
Data inputs for multispecies CEATTLE of the Bering Sea from 1979 to 2017BS2017MS
Data inputs for single species CEATTLE of the Bering Sea from 1979 to 2017BS2017SS
Build parameter boundsbuild_bounds
Catchability specificationbuild_catchability
Composition-weighting specificationbuild_composition
Build an Rceattle data list in Rbuild_data
Specify the growth model for Rceattlebuild_growth
Specify the harvest control rule (HCR) used for Rceattlebuild_hcr
Function to construct the TMB map argument for CEATTLE for projecting under alternative harvest control rulesbuild_hcr_map
Specify the residual natural mortality (M1) model for Rceattlebuild_M1
Main function to construct the TMB map argument for CEATTLEbuild_map
Helper to set map for Catchability parametersbuild_map_catchability
Helper to set map for debug modebuild_map_debug
Helper to set map for Fishing Mortality and Data Weightsbuild_map_f_and_data_weights
Helper to set map for Fixed N-at-Age modelsbuild_map_fixed_natage
Helper to set map for growth parametersbuild_map_growth
Helper to set map for Natural Mortality (M1) parametersbuild_map_m1
Helper to set map for Predation Mortality (M2) parametersbuild_map_predation
Helper to set map for Recruitment parametersbuild_map_recruitment
Helper to set map for Selectivity parametersbuild_map_selectivity
Build parameter list from cpp filebuild_params
Selectivity specificationbuild_selectivity
Specify the stock-recruit relationship (SRR) for Rceattlebuild_srr
Check which saved MSE simulation files can be loadedcheck_mse
Default-fill and tidy a data list before fittingclean_data
Extract estimated parameters from an Rceattle fitcoef.Rceattle
Combine two Rceattle data listscombine_data
Evaluate simulation performancecompare_sim
Convergence diagnostics for a fitted Rceattle modelconvergence_diagnostics
Report which data inputs a model configuration requiresdata_requirements
Fitted multispecies CEATTLE model for the Eastern Bering SeaEBS_ms_run
Fitted single-species CEATTLE model with estimated M for the Eastern Bering SeaEBS_ss_M_run
Fitted single-species CEATTLE model for the Eastern Bering SeaEBS_ss_run
Bundle the optimizer / sdreport / phasing controls for 'fit_mod()'fit_control
Fit the CEATTLE assessment modelfit_mod
Data inputs for a three-species Georges Bank CEATTLE modelGeorgesBank3spp
Generate Length-at-Age Transition Matrixget_growth_matrix_r
Calculate Predicted Weight-at-Ageget_weight_at_age_r
Data inputs for a single-species Gulf of Alaska CEATTLE model (2018)GOA2018SS
Data inputs for Gulf of Alaska arrowtooth flounder CEATTLE modelGOAatf
Data inputs for Gulf of Alaska arrowtooth flounder CEATTLE model (2023)GOAatf2023
Data inputs for Gulf of Alaska Pacific cod CEATTLE modelGOAcod
Data inputs for Gulf of Alaska walleye pollock CEATTLE modelGOApollock
Gulf of Alaska 2018 SAFE report reference valuesGOAsafe2018
Jitter analysisjitter
Capture a linkage specificationlinkage_spec
Load a model run configuration from a YAML fileload_config
Load saved MSE simulation runsload_mse
Log-likelihood of an Rceattle fitlogLik.Rceattle
Model average of derived quantitiesmodel_average
Build a model-configuration slot for a data listmodel_config
Management strategy evaluation performance metric summarymse_summary
Data inputs for Northern Rockfish CEATTLE model (2022)NorthernRockfish2022
Statistical diagnostics for OSA residualsosa_diagnostics
One-step-ahead (OSA) residuals for an Rceattle modelosa_residuals
Look up what a CEATTLE parameter isparameter_dictionary
Locate every estimated parameter in the model's own coordinatesparameter_index
Plot biomass eaten by predationplot_b_eaten
Plot biomass consumed of each prey species by predatorplot_b_eaten_prop
Plot biomassplot_biomass
Fishery catch fitsplot_catch
Survey catchability over timeplot_catchability
Plot composition fits and residualsplot_comp
Timeline of data used in the model likelihoodsplot_data
Plot biomass depletionplot_depletion
Plot SSB depletion (deprecated name)plot_depletionSSB
Plot diet composition fitsplot_diet_comp
Plot diet composition fits (bubble/grid diagnostic)plot_diet_comp1
Plot diet composition fits (aggregation-aware)plot_diet_comp2
Plot exploitable biomassplot_exploitable_biomass
plot Fplot_f
Plot functional formplot_form
Survey index fitsplot_index
Survey index residualsplot_index_residual
Plot survey index residuals (deprecated name)plot_indexresidual
Plot natural mortality by ageplot_m_at_age
Plot predation mortality by age and predatorplot_m2_at_age_prop
Plot maturityplot_maturity
Plot M1 or M2 at ageplot_mortality
Plot the likelihood components across a profileplot_profile
Plot rationplot_ration
Plot recruitmentplot_recruitment
Plot selectivityplot_selectivity
Plot fishery selectivity and maturityplot_selectivity_vs_maturity
Plot spawning stock biomass (SSB)plot_ssb
Plot SSB depletionplot_ssb_depletion
Plot stock recruit functionplot_stock_recruit
Plot time-seriesplot_timeseries
Plot method for fitted Rceattle modelsplot.Rceattle
Plot one-step-ahead (OSA) residual diagnosticsplot.rceattle_osa
Plot method for a likelihood profileplot.Rceattle_profile
Print method for fitted Rceattle modelsprint.Rceattle
Print method for an Rceattle data listprint.Rceattle_data summary.Rceattle_data
Print method for a jitter analysisprint.Rceattle_jitter
Print method for an MSE summaryprint.Rceattle_mse_summary
Print method for a likelihood profileprint.Rceattle_profile
Print method for a set of assessment reporting tablesprint.rceattle_report
Print method for a retrospective analysisprint.Rceattle_retro
Print method for a self-testprint.Rceattle_selftest
Print method for an Rceattle model summaryprint.summary.Rceattle
Beta prior on a linkage coefficientprior_beta
Gamma prior on a linkage coefficientprior_gamma
Lognormal prior on a linkage coefficientprior_lognormal
Normal prior on a linkage coefficientprior_normal
Process residuals for an Rceattle model's random-effect processesprocess_residuals
Likelihood components along a profileprofile_components
Likelihood profile across one or more parameter cellsprofile.Rceattle
Look up what a CEATTLE reported quantity isquantity_dictionary
Shared plotting argumentsrceattle-plot-args
Shared refit-diagnostic argumentsrceattle-refit-args
Read a CEATTLE excel data fileread_data
Rearrange a data_list for TMBrearrange_dat rearrange_data
Rerun with F = 0.remove_F
Label the derived quantities reported by a CEATTLE fitrename_output
Assessment reporting tables from one or more Rceattle fitsreport_tables
Residuals from an Rceattle fitresiduals.Rceattle
Retrospective peelsretrospective
Iteratively reweight composition data (McAllister-Ianelli)reweight_comps
Make a vector of colors.rich.colors.short
Extract the run configuration from a fit, data list, or config objectrun_config
Run a management strategy evaluationrun_mse
Sample historical recruitment deviations into the projectionsample_rec
Save a model run configuration to a documented YAML filesave_config
Self-test simulation analysisself_test
Default phasing order for CEATTLE parametersset_phases
Simulate Rceattle datasim_mod
Simulate data from a fitted Rceattle modelsimulate.Rceattle
Rceattle output in the NOAA standardized assessment formatstandard_output
Compact summary method for Rceattle fitssummary.Rceattle
Function to check for missing switches for map and parameter functionsswitch_check
Calculate marginal AIC for a fitted modelTMBAIC
Run TMB with ADMB-style phased estimationTMBphase
Variance-covariance matrix for an Rceattle fitvcov.Rceattle
Data inputs for CEATTLE model with WHAM-estimated growthwhamGrowthData
Write a data list to a CEATTLE xlsx workbookwrite_data
Write a minimal starter CEATTLE data workbookwrite_template