predictor_spec {IxPopDyMod} | R Documentation |
Specify how a single predictor should be used
Description
Specify how a single predictor should be used
Usage
predictor_spec(pred, first_day_only = TRUE)
Arguments
pred |
String indicating where to get predictor data. Can be one of:
A string in the "pred" column in the predictors table.
In this case, the predictor value passed to the containing
transition 's fun is the corresponding value of that
predictor in the table.
A string that matches at least one life stage name via regex. In this
case, the value passed to the containing transition 's fun
is the sum of the population sizes of all matched life stages.
|
first_day_only |
Boolean indicating whether to repeat the predictor data
value from the first day of a transition when evaluating it
(TRUE case), or to use the range of predictor data over the duration of a
transition (FALSE case). FALSE is only valid for transition s
with "duration" as the transition_type , because "probability" type
transitions only last one day. A value of FALSE also requires the name
parameter to be a value in the predictors table "pred"
column, not a tick life stage.
|
Value
a predictor_spec
list-based object
[Package
IxPopDyMod version 0.3.0
Index]