Class

Public S4 class after importing xlsx file into R with the IAM package.

Details

The iamInput class has methods defined for creation of a new object, usage in iamArgs initiation and in IAM.Model.

Slots

desc

Short description of the object. chr.

specific

structural dimension

Species: Stock vector with 3 letter abreviation of species name and sotck number. chr vector
StaticSpp: Static species. These ones are landed but are not included in dynamic structure. This information is extracted from the Fleet sheet. chr vector
AllSpp: All the stocks names concatenated from Species and StaticSpp. chr vector
Fleet: Fleet types, defined thanks to vessel length, area and times. A vesserl can have multiple Metier. chr vector
Metier: Typology depending on fishing gear, vessel length, area and times of fisheries. chr vector
MetiersEco: Economic metier, depending on fishing gear. chr vector
Ages: Ages structure for each dynamic species. List of chr vector
Cat: Economic type for each dynamic species. List of chr vector
t_init: Initial year of the model. int
NbSteps: Number of years for the model to be used. Initial year is included as step 0. int vector
times: Years used in the model. Defined with t_init and NbSteps
Q: Status of species. 0 mean XSA dynamic 1 mean SS3 dynamic
S: Status of species. 0 mean XSA dynamic 1 mean SEX dynamic. A species can't be SS3 and SEX.

historical

List of input for all species and fleet. Each element is a list of variable in different format table. This slot is not used in C++ because all data are prior to simulation year start.

input

List of input for all species and fleet. Each element is a list of variable in different format table.

scenario

List of scenarii with each containing one element per species and one supplementary element for Fleets.

stochastic

Stochastic parameters for stock recrutment. Will be used in iamArgs in place of recruitment functions.

optimization

Deprecated slot.

Author

Mathieu Merzereaud

Examples

showClass("iamInput")
#> Class "iamInput" [package "IAM"]
#> 
#> Slots:
#>                                                                        
#> Name:          desc     specific   historical        input     scenario
#> Class:    character         list         list         list         list
#>                                 
#> Name:    stochastic optimization
#> Class:         list         list