Description Usage Arguments Value
View source: R/get_recovery_metrics.R
Calculate recovery metrics
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | calcRecMetrics(
tsi,
tdist,
obspyr,
nPre,
nDist,
nPost,
nPostStart,
nDelta,
nDeltaStart,
tbp,
selBreak,
chkBrk = F,
timeThres
)
|
tsi |
vector of observations (time series with a fixed observation frequency) |
tdist |
observation number of disturbance, indicating the timing of the disturbance |
obspyr |
number of observations per year |
nPre |
number of years prior to the disturbance used to calculate the pre-disturbance value |
nDist |
number of years used to quantify the state during the disturbance |
nPost |
number of years used to calculate the post-disturbance value |
nPostStart |
indicates the start of the post-disturbance period (expressed as number of years after the disturbance) |
nDelta |
number of years used to calculate the post-disturbance value for the YrYr metric |
nDeltaStart |
indicates the start of the post-disturbance period for the YrYr metric (expressed as number of years after the disturbance) |
tbp |
breakpoints in time series |
selBreak |
How should the breakpoint be selected to calculate recovery metrics: max = maximum break, close = the break closed to tdist, first = first negative break (if no negative breaks are found, it takes the first break). |
chkBrk |
should time series be checked for breaks within the post- or pre-disturbance period? |
timeThres |
the maximum allowed time difference between the observed break and the disturbance years |
a list containing the RRI recovery indicator, R80p recovery indicator, YrYr recovery indicator, disturbance impact, and pre-disturbance state
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.