ToxModifier: Size-dependent Toxicity Modifier

Description Usage Arguments Details Value

View source: R/ToxModifier.R

Description

Two built in functions to modify survival dercrement based on either a linear interpolation of toxicity effects or a step function for size classes

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
ToxModifier(
  z,
  toxModType,
  toxMultU,
  toxMultL,
  upperBound,
  lowerBound,
  zPartition,
  toxModVec
)

Arguments

z

Size at the beginning of the timestep [float or vector]

toxModType

String to switch between the two current options, "linear", or "step"

toxMultU

Toxicity multiplier at upper bound size 'upperBound' [float]

toxMultL

Toxicity multiplier at lower bound size 'lowerBound' [float]

upperBound

Upper size limit in the model [float]

lowerBound

Lower size limit in the model [float]

zPartition

Size partition of the size range. Uses 'stepfun' from 'stats' package, please see help for additional details on using 'stepfun' [vector]

toxModVec

Multipliers for each component of 'zPartition' vector [vector]

Details

Linear: Linear transition between largest and smallest classes

ToxModifier(z) =((toxMultU-toxMultL)/(upperBound-lowerBound))*(z-upperBound)+toxMultU

Step: Step function to assign discrete multipliers to size classes

ToxModifier(z) = ∑_{i=0}^{n}{mVec_i * \textbf{1}_{\zPartition_{i}}(z)}

Value

Toxicity multiplier as a function of size [float]


npollesch/FishToxTranslator documentation built on May 23, 2021, 3:21 a.m.