create.FLIBM: Create initial FLIBM object

View source: R/create.FLIBM.R

create.FLIBMR Documentation

Create initial FLIBM object

Description

Create initial FLIBM object

Usage

create.FLIBM(
  lengths = seq(0, 85),
  ages = 0:6,
  years = ac(2000:2009),
  units = "unique",
  seasons = ac(1:12),
  areas = "unique",
  iters = "1",
  n.units = "1e3",
  wt.units = "kg",
  name = "synStock",
  desc = "A synthetic stock",
  inds = NULL
)

Arguments

lengths

vector. Lengths to define the length extent of the length-based FLStock object (lower bin extent).

ages

vector. Ages to define the age extent of the age-based FLStock object (lower bin extent).

years

vector. Years to define the 'year' extent of the FLStock object.

units

vector. Unitss to define the 'unit' extent of the FLStock object.

seasons

vector. Seasons to define the 'season' extent of the FLStock object.

areas

vector. Areas to define the 'area' extent of the FLStock object.

iters

vector. Iters to define the 'iter' extent of the FLStock object.

n.units

character. Units decribing the scale for numbers used in the FLStock object. If value is higher than "1" (e.g. "1e3"), then individuals in the IBM are also considered as "super-individuals", representing a aggregate of individuals with like attributes. (Default="1e3")

wt.units

character. Units decribing the scale for individual weights used in the FLStock object, and in the IBM. (Default="kg").

name

character. Name of stock.

desc

character. Description of stock.

inds

data.frame. (Super-) individuals (rows) of the current population state with their attributes (column variables).

Value

FLIBM object

Examples

stk <- create.FLIBM()
summary(stk)


marchtaylor/FLIBM documentation built on Jan. 19, 2025, 10:56 p.m.