summary.Bioenergetic: Summary Method for Bioenergetic Objects

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

Summary Method for Bioenergetic Objects

Description

Prints a detailed multi-section summary of a Bioenergetic object, covering species identity, parameter categories, environmental data statistics, diet composition, simulation settings, and overall readiness status. Complements print.Bioenergetic, which shows the compact single-page view.

Usage

## S3 method for class 'Bioenergetic'
summary(object, ...)

Arguments

object	Bioenergetic object
...	Additional arguments (not used)

Value

Invisibly returns the input object

Examples

data(fish4_parameters)
sp   <- fish4_parameters[["Oncorhynchus tshawytscha"]]$life_stages$adult
info <- fish4_parameters[["Oncorhynchus tshawytscha"]]$species_info
bio  <- Bioenergetic(
  species_params     = sp,
  species_info       = info,
  environmental_data = list(
    temperature = data.frame(Day = 1:30, Temperature = rep(12, 30))
  ),
  diet_data = list(
    proportions = data.frame(Day = 1:30, Prey1 = 1.0),
    energies    = data.frame(Day = 1:30, Prey1 = 5000),
    prey_names  = "Prey1"
  ),
  simulation_settings = list(initial_weight = 100, duration = 30)
)
summary(bio)

fb4package documentation built on May 8, 2026, 1:07 a.m.