twCreateModMeta

Description

Creating meta-information about rows (stateVars), isotopes (columns), and additonal outputs.

Usage

1
twCreateModMeta(rowNames, csts, iRUnits = 1, auxGroups = list())

Arguments

rowNames

character vector: names of the state variables

csts

list of character vectors: for each element, the isotopes are listed.

<< Each first entry should be the reference with isotopic ratio of one (e.g. c12 or n15)

iRUnits

numeric vector of units for different isotopes,

<< ensuring equal magnitudes to avoid numerical errors (see details)

auxGroups

mapping namegroup (character) -> columnNames (character vector): column names of auxiliary outputs

Details

Based on the given basic arguments, derived information is stored within the meta-information data structure.

So that this derived information does not need to be recalculated at different places.

iRUnits

By default all units are 1.

If names are not given, is is assumed that order corresponds to colNames

If names are given, default 1 for c12 and n15 are added.

Value

a list with components

rowNames

character vector: names of the state variables

csts

list of character vectors: for each element, the isotopes are listed.

<< Each first entry should be the reference with isotopic ratio of one (e.g. c12 or n15)

colNames

character vector: names of the isotopes

elementNames

character vector: names of the elements row_column

iRUnits

numeric vector of units for different isotopes,

<< ensuring equal magnitudes to avoid numerical errors (see details)

auxGroups

mapping namegroup (character) -> columnNames (character vector): column names of auxiliary outputs

auxOutputNames

character vector: names of all auxiliary outputs

auxOutputTemplate

numeric vector, with names corresponding to auxOutputNames

nRow

number of rows

nCol

number of columns

matrixTemplate

numeric matrix: template for state variable matrix with corresponding row and column names

nAux

number of auxiliary outputs

Author(s)

Thomas Wutzler