fish4_parameters_metadata: Fish Bioenergetics 4.0 Parameters Database Metadata

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

Fish Bioenergetics 4.0 Parameters Database Metadata

Description

Metadata information about the Fish Bioenergetics 4.0 parameters database, including version information, creation details, and structural specifications.

Usage

fish4_parameters_metadata

Format

A list containing metadata about the fish4_parameters database:

version

Version number of the database

creation_date

Date when the database was generated

source_file

Original CSV file used to generate the database

description

Brief description of the database contents

n_species

Total number of species in the database

n_total_records

Total number of parameter records

families_included

Number of taxonomic families represented

parameter_groups

Vector of parameter category names

required_parameters

List of essential parameters for FB4 simulations

units

Description of parameter units and measurements

Details

This metadata object provides essential information about the structure, content, and requirements of the fish4_parameters database. It includes quality control information and parameter specifications necessary for proper use of the bioenergetic model.

Required Parameters: The metadata specifies which parameters are essential for running Fish Bioenergetics 4.0 simulations:

Consumption:

CA, CB, CQ, CTO, CTM, CTL

Respiration:

RA, RB, RQ, RTO, RTM, RTL

Units:

Temperature:

Degrees Celsius

Energy Density:

Joules per gram (J/g)

Weight:

Grams (g)

Rates:

Proportions or model coefficients

Source

Generated automatically when converting Parameters_official.csv (from the Fish Bioenergetics 4.0 Shiny application, <https://github.com/biofish/FishBioenergetics>) into an R list object.

See Also

fish4_parameters, Bioenergetic

Examples

data(fish4_parameters_metadata)
print(fish4_parameters_metadata$description)
print(paste("Species count:", fish4_parameters_metadata$n_species))

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