Package: fb4package 2.1.1

fb4package: 'Fish Bioenergetics 4.0' Model Implementation with High-Performance 'TMB' Backend

An implementation of the 'Fish Bioenergetics 4.0' framework described in Deslauriers et al. (2017) <doi:10.1080/03632415.2017.1377558>. Provides automated parameter optimization, multi-prey diet modeling, and comprehensive energy budget simulations for fisheries research and aquaculture applications. An optional 'TMB' (Template Model Builder) backend delivers 10-50x speedup in maximum likelihood estimation while maintaining full backward compatibility. Includes species-specific parameter databases and tools for modeling fish growth, consumption, and metabolism under varying environmental conditions.

Authors:Hans Ttito [aut, cre]

fb4package_2.1.1.tar.gz
fb4package_2.1.1.zip(r-4.7)fb4package_2.1.1.zip(r-4.6)fb4package_2.1.1.zip(r-4.5)
fb4package_2.1.1.tgz(r-4.6-x86_64)fb4package_2.1.1.tgz(r-4.6-arm64)fb4package_2.1.1.tgz(r-4.5-x86_64)fb4package_2.1.1.tgz(r-4.5-arm64)
fb4package_2.1.1.tar.gz(r-4.7-arm64)fb4package_2.1.1.tar.gz(r-4.7-x86_64)fb4package_2.1.1.tar.gz(r-4.6-arm64)fb4package_2.1.1.tar.gz(r-4.6-x86_64)
fb4package_2.1.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
fb4package/json (API)

# Install 'fb4package' in R:
install.packages('fb4package', repos = c('https://hansttito.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/hansttito/fb4package/issues

Pkgdown/docs site:https://hansttito.github.io

Uses libs:
  • c++– GNU Standard C++ Library v3
Datasets:

On CRAN:

Conda:

cpp

5.56 score 1 stars 11 scripts 273 downloads 90 exports 5 dependencies

Last updated from:dacae48416. Checks:11 WARNING, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64WARNING235
linux-devel-x86_64WARNING238
source / vignettesOK316
linux-release-arm64WARNING232
linux-release-x86_64WARNING227
macos-release-arm64WARNING168
macos-release-x86_64WARNING340
macos-oldrel-arm64WARNING190
macos-oldrel-x86_64WARNING310
windows-develWARNING189
windows-releaseWARNING201
windows-oldrelWARNING184
wasm-releaseOK158

Exports:accumulate_validationsanalyze_composition_by_sizeanalyze_composition_changesanalyze_energy_budgetanalyze_feeding_performanceanalyze_growth_patternsanalyze_growth_temperature_sensitivityanalyze_population_variationassess_diet_qualityBioenergeticcalculate_body_compositioncalculate_confidence_intervalscalculate_consumptioncalculate_contaminant_accumulationcalculate_egestioncalculate_excretioncalculate_final_weight_fb4calculate_mortality_reproductioncalculate_np_ratioscalculate_nutrient_balancecalculate_nutrient_efficienciescalculate_predator_energy_densitycalculate_respirationcalculate_stoichiometric_balancecheck_numeric_valueclampcompare_individualscompare_scenarioscompare_with_redfieldcomprehensive_nutritional_analysiscreate_empty_compositioncreate_result_summaryget_consumption_uncertaintyget_efficiency_uncertaintyget_energy_budget_uncertaintyget_individual_resultsget_parameter_valueget_population_resultsinterpolate_time_seriesis.Bioenergeticis.fb4_resultplot_distributions.fb4_resultplot_growth_temperature_sensitivityplot_sensitivity.fb4_resultplot_uncertainty.fb4_resultpredict_consumption_bootstrappredict_consumption_deltaprepare_simulation_dataprocess_bioenergetic_dataprocess_composition_paramsprocess_consumption_paramsprocess_contaminant_paramsprocess_egestion_paramsprocess_excretion_paramsprocess_mortality_paramsprocess_nutrient_paramsprocess_predator_paramsprocess_respiration_paramsprocess_simulation_settingsprocess_species_parametersrun_fb4run_fb4_simulationsafe_expsafe_sqrtset_dietset_environmentset_parameter_valueset_simulation_settingsupdate_body_compositionvalidate_basic_paramsvalidate_bioenergetic_for_simulationvalidate_body_compositionvalidate_complete_simulation_datavalidate_contaminant_paramsvalidate_data_consistencyvalidate_diet_consistencyvalidate_equation_paramsvalidate_fb4_inputsvalidate_fb4_systemvalidate_fitting_settingsvalidate_fractionvalidate_individual_datavalidate_nutrient_concentrationsvalidate_positivevalidate_predator_energy_paramsvalidate_species_equationsvalidate_temperaturevalidate_temporal_datavalidate_time_series_datavalidation_result

Dependencies:latticeMatrixRcppRcppEigenTMB

Case Study: Chinook Salmon Bioenergetics
Overview | 1. Species parameters | 2. Environmental data | 3. Diet composition | 4. Building the Bioenergetic object | Setup visualisation | 5. Estimating consumption — binary search | Growth trajectory | Energy budget | Full dashboard | 6. Consumption with a fixed feeding level | 7. Bootstrap uncertainty estimation | 8. Result analysis | 9. Ecological interpretation | References

Last update: 2026-06-10
Started: 2026-03-29

Introduction to fb4package
Overview | 1. Species parameters | 2. Environmental and diet data | 3. Building a Bioenergetic object | 4. Running simulations | 4a. Direct simulation — fixed feeding level | 4b. Binary search — fit to a target final weight | 4c. MLE — uncertainty on p from observed weights | 4d. Bootstrap — non-parametric uncertainty | 5. Comparing strategies | 6. Analysing results | 7. Visualising results | 8. Temperature × p sensitivity | 9. Experimental features | Contaminant bioaccumulation | Nutrient regeneration | Mortality rates | References

Last update: 2026-06-10
Started: 2025-07-19

Statistical estimation strategies
Overview | Shared setup | Strategy 1 — Binary search | Strategy 2 — Optimisation (optim) | Strategy 3 — Maximum Likelihood Estimation | Strategy 4 — Bootstrap | Strategy 5 — Hierarchical model (mark-recapture) | Biological context | Simulating a mark-recapture data set | Running the hierarchical model | Assumptions and limitations | Comparing strategies | Strategies 1–4: single-population estimates | Strategy 5: population-level distribution | References

Last update: 2026-06-10
Started: 2026-03-29

Temperature Sensitivity and Climate Change Scenarios
Overview | 1. Base model — juvenile Chinook salmon | 2. Manual sensitivity analysis across temperature offsets | 3. Built-in sensitivity plot | 4. Climate change scenarios — projected growth | 5. Thermal performance window | 6. Management implications | References

Last update: 2026-06-10
Started: 2026-03-29

Validation against FB4-Shiny
Overview | 1. Shared setup | Species parameters — Chinook salmon | Scalar extraction helper | Derived temperature coefficients | Simulation inputs | 2. FB4-Shiny reference implementation | 3. fb4package object | 4. Comparison helper | 5. Five simulation modes | Method 1 — Fixed p-value (direct) | Method 2 — Final weight target (binary search) | Method 3 — Total consumption target (binary search) | Method 4 — Fixed ration as % body weight (direct) | Method 5 — Fixed ration in g/day (direct) | 6. Results summary | Weight trajectory — Methods 1 and 2 | Daily weight residuals | Note on Energy_density | 7. Nutrient sub-model validation | 8. Contaminant sub-model validation | 9. Conclusion | References

Last update: 2026-06-07
Started: 2026-06-07

Exploring the Species Parameter Database
Overview | 1. Loading and inspecting the database | 2. Database structure | 3. Searching the database | By scientific name (partial match) | By common name | 4. Listing available life stages | 5. Comparing consumption parameters across species | Temperature optima distribution | 6. Predator energy density equations | 7. Building a model directly from the database | 8. Adding a custom species | References

Last update: 2026-03-29
Started: 2026-03-29

Readme and manuals

Help Manual

Help pageTopics
Accumulate multiple validation resultsaccumulate_validations
Core Analysis Functions for FB4 Resultsanalysis-core
Basic Analysis and Extraction Functions for FB4 Resultsanalysis-extraction
Nutritional Analysis Functions for FB4 Resultsanalysis-nutritional
Sensitivity and Comparative Analysis Functions for FB4 Resultsanalysis-sensitivity
Analyze body composition by size rangeanalyze_composition_by_size
Analyze composition changes with growthanalyze_composition_changes
Analyze energy budget from FB4 resultsanalyze_energy_budget
Analyze feeding performance from FB4 resultsanalyze_feeding_performance
Analyze growth patterns from FB4 resultsanalyze_growth_patterns
Analyze growth rate sensitivity to temperature and feeding levelsanalyze_growth_temperature_sensitivity
Analyze population variation in hierarchical modelsanalyze_population_variation
Assess nutritional quality of dietassess_diet_quality
Basic Validation Functions for FB4basic-validators
Constructor for Bioenergetic ObjectsBioenergetic
S3 Classes for FB4 Bioenergetic Modelbioenergetic-classes
Methods for FB4 Bioenergetic Modelbioenergetic-methods
Body Composition Functions for FB4 Modelbody-composition
Calculate complete body composition (Mid-level - Main function)calculate_body_composition
Calculate daily consumption (Mid-level - Main function)calculate_consumption
Calculate contaminant accumulation (Mid-level - Main function)calculate_contaminant_accumulation
Calculate daily egestion (Mid-level - Main function)calculate_egestion
Calculate daily excretion (Mid-level - Main function)calculate_excretion
Calculate final weight using FB4 equations (Mid-level)calculate_final_weight_fb4
Calculate daily mortality and reproduction (Mid-level - Main function)calculate_mortality_reproduction
Calculate N:P ratios for all processescalculate_np_ratios
Calculate nutrient balance (Mid-level - Main function)calculate_nutrient_balance
Calculate nutrient retention efficienciescalculate_nutrient_efficiencies
Calculate predator energy density (Mid-level - Main function)calculate_predator_energy_density
Calculate daily respiration (Mid-level - Main function)calculate_respiration
Calculate stoichiometric balancecalculate_stoichiometric_balance
Check Numeric Valuecheck_numeric_value
Compare individuals from hierarchical modelscompare_individuals
Compare multiple FB4 resultscompare_scenarios
Compare N:P ratios with Redfield ratioscompare_with_redfield
Comprehensive nutritional analysiscomprehensive_nutritional_analysis
Consumption Functions for FB4 Modelconsumption-functions
Contaminant Accumulation Functions for FB4 Modelcontaminant-accumulation
Core Validation Functions for FB4core-validators
Create empty composition for invalid inputs (Utility)create_empty_composition
Comprehensive post-simulation analysis summarycreate_result_summary
Data Processing Functions for FB4data-processing
Data Validation Functions for FB4data-validators
Egestion and Excretion Functions for FB4 Modelegestion-excretion
Analysis Plots for FB4 Results (Uncertainty and Sensitivity)fb4-analysis-plots
Bioenergetic Object Plots for Setup Validationfb4-bioenergetic-plots
Daily Simulation Plots for FB4 Resultsfb4-daily-plots
Core Plotting Functions for FB4 Resultsfb4-plot-core
FB4 Plotting Functionsfb4-plots
FB4 TMB Shared FunctionsFB4-TMB-Shared
Fish Bioenergetics 4.0 Official Parameters Databasefish4_parameters
Fish Bioenergetics 4.0 Parameters Database Metadatafish4_parameters_metadata
Get consumption results with uncertaintyget_consumption_uncertainty
Get efficiency results with uncertaintyget_efficiency_uncertainty
Get energy budget components with uncertaintyget_energy_budget_uncertainty
Get individual results from hierarchical modelsget_individual_results
Get Parameter Value from Species Parametersget_parameter_value
Get population results from hierarchical modelsget_population_results
Interpolate time series with error handlinginterpolate_time_series
Test if Object is Bioenergeticis.Bioenergetic
Test if Object is fb4_resultis.fb4_result
Main Validation Functions for FB4main-validators
Mortality and Reproduction Functions for FB4 Modelmortality-reproduction
Nutrient Regeneration Functions for FB4 Modelnutrient-regeneration
Parameter Processing Functions for FB4parameter-processing
Parameter Validation Functions for FB4parameter-validators
Plot parameter distributions for bootstrap and hierarchical methodsplot_distributions.fb4_result
Plot sensitivity analysisplot_growth_temperature_sensitivity
Plot temperature sensitivity analysis for a Bioenergetic objectplot_sensitivity.fb4_result
Plot parameter uncertainty for probabilistic methodsplot_uncertainty.fb4_result
Plot Bioenergetic object setupplot.Bioenergetic
Plot FB4 simulation resultsplot.fb4_result
Predator Energy Density Functions for FB4 Modelpredator-energy-density
Bootstrap method for consumption uncertainty propagationpredict_consumption_bootstrap
Delta method for consumption uncertainty propagationpredict_consumption_delta
Prepare all simulation dataprepare_simulation_data
Print Method for Bioenergetic Objectsprint.Bioenergetic
Print Method for fb4_result Objectsprint.fb4_result
Process Bioenergetic object temporal data for simulationprocess_bioenergetic_data
Process body composition parametersprocess_composition_params
Process consumption parametersprocess_consumption_params
Process contaminant parametersprocess_contaminant_params
Process egestion parametersprocess_egestion_params
Process excretion parametersprocess_excretion_params
Process mortality parametersprocess_mortality_params
Process nutrient parametersprocess_nutrient_params
Process predator energy density parametersprocess_predator_params
Process respiration parametersprocess_respiration_params
Process simulation settingsprocess_simulation_settings
Process all species parameters for simulationprocess_species_parameters
Respiration Functions for FB4 Modelrespiration-functions
Result Builders for FB4 Modelresult-builders-unified
Run FB4 Simulationrun_fb4 run_fb4.default
Run complete FB4 simulation (Mid-level - Main function)run_fb4_simulation
Run FB4 simulation on Bioenergetic objectrun_fb4.Bioenergetic
FB4 Main Orchestratorrun-fb4-orchestrator
Set Diet Data for Bioenergetic Objectsset_diet
Set Environmental Data for Bioenergetic Objectsset_environment
Set Parameter Value in Species Parametersset_parameter_value
Set Simulation Settings for Bioenergetic Objectsset_simulation_settings
Simulation Engine for FB4 Modelsimulation-engine
Binary Search Strategy for FB4 Modelstrategy-binary-search
Bootstrap Estimation Strategy for FB4 Modelstrategy-bootstrap
Strategy Commons for FB4 Modelstrategy-commons
Direct Strategies for FB4 Modelstrategy-direct
Hierarchical Estimation Strategy for FB4 Modelstrategy-hierarchical
Strategy Interface and Factory for FB4 Modelstrategy-interface
Maximum Likelihood Estimation Strategy for FB4 Modelstrategy-mle
Optimisation Strategy for FB4 Modelstrategy-optim
Summary Method for Bioenergetic Objectssummary.Bioenergetic
Summary Method for fb4_result Objectssummary.fb4_result
FB4 Uncertainty Propagation Functionsuncertainty-prediction
Update body composition during simulation (Mid-level)update_body_composition
Utility Functions for fb4packageutils
Validate Basic Model Parametersvalidate_basic_params
Comprehensive validation for Bioenergetic objectsvalidate_bioenergetic_for_simulation
Validate body compositionvalidate_body_composition
Validate contaminant parametersvalidate_contaminant_params
Validate inputs for FB4 simulationvalidate_fb4_inputs
Validate complete FB4 system ready for simulationvalidate_fb4_system
Validate fraction values (0-1 range)validate_fraction
Validate individual data for hierarchical modelsvalidate_individual_data
Validate nutrient concentrationsvalidate_nutrient_concentrations
Validate positive valuesvalidate_positive
Validate predator energy density parametersvalidate_predator_energy_params
Main function to validate all species equationsvalidate_species_equations
Validate temperature valuesvalidate_temperature
Validate Time Series Data Structure (Basic Level)validate_time_series_data
Create standardized validation resultvalidation_result