getRecoveredTransitionDuration {paleoAM} | R Documentation |
How long did a transition proceed from background to peak 'event' v
getRecoveredTransitionDuration(
simRecord,
bgUpperEnvelope,
eventLowerEnvelope = NULL,
returnAsAge = FALSE,
trueEventDuration = NA,
plot = FALSE
)
simRecord |
A simulated fossil record with assemblage change across multiple time-steps, with sedimentary thickness modeled. |
bgUpperEnvelope |
The upper envelope on what is considered a background value for a gradient value derived from the assemblage. |
eventLowerEnvelope |
The lower envelope on what is considered an event value for a gradient value derived from the assemblage. |
returnAsAge |
Should the estimated duration of the transition be returned as a duration in time-units? If |
trueEventDuration |
The true duration of the event. This must be provided by the user if |
plot |
Should the data be plotted with the estimated transition interval on it, for visual checking? |
The envelope values can be calculated different ways, or even picked arbitrarily by the user. For example, bgUpperEnvelope
is the upper envelope on what is considered a background value for a gradient value derived from the assemblage (for example, an ordination score). One way a user could calculate bgUpperEnvelope
would be to repeatedly simulate assemblages at the background value, calculate their apparent gradient value and estimate a 0.95 or 0.975 quantile. This can be done easily with function simulateGradientQuantile
.
A single value, reflecting (by default) a ratio of transition duration over the event duration. Can be modified with argument returnAsAge
.