From 27b705f007c3aa535f774c3adcc060ddd8d554fc Mon Sep 17 00:00:00 2001 From: steffenhartmeyer Date: Mon, 2 Sep 2024 16:04:58 +0200 Subject: [PATCH] Small fix in default values --- R/metric_pulses_above_threshold.R | 8 ++++---- man/pulses_above_threshold.Rd | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/metric_pulses_above_threshold.R b/R/metric_pulses_above_threshold.R index 6cb8dca..2398977 100644 --- a/R/metric_pulses_above_threshold.R +++ b/R/metric_pulses_above_threshold.R @@ -21,11 +21,11 @@ #' @param min.length The minimum length of a pulse. Can be either a #' \link[lubridate]{duration} or a string. If it is a string, it needs to be a valid #' \link[lubridate]{duration} string, e.g., `"1 day"` or `"10 sec"`. Defaults to -#' `"8 mins"` as in Wilson et al. (2018). +#' `"2 mins"` as in Wilson et al. (2018). #' @param max.interrupt Maximum length of each episode of interruptions. Can be either a #' \link[lubridate]{duration} or a string. If it is a string, it needs to be a valid #' \link[lubridate]{duration} string, e.g., `"1 day"` or `"10 sec"`. Defaults to -#' `"2 mins"` as in Wilson et al. (2018). +#' `"8 mins"` as in Wilson et al. (2018). #' @param prop.interrupt Numeric value between `0` and `1` specifying the #' maximum proportion of the total number of interruptions. Defaults to `0.25` #' as in Wilson et al. (2018). @@ -85,8 +85,8 @@ pulses_above_threshold <- function(Light.vector, Time.vector, comparison = c("above", "below"), threshold, - min.length = "8 mins", - max.interrupt = "2 mins", + min.length = "2 mins", + max.interrupt = "8 mins", prop.interrupt = 0.25, epoch = "dominant.epoch", return.indices = FALSE, diff --git a/man/pulses_above_threshold.Rd b/man/pulses_above_threshold.Rd index 2991193..1b26c33 100644 --- a/man/pulses_above_threshold.Rd +++ b/man/pulses_above_threshold.Rd @@ -9,8 +9,8 @@ pulses_above_threshold( Time.vector, comparison = c("above", "below"), threshold, - min.length = "8 mins", - max.interrupt = "2 mins", + min.length = "2 mins", + max.interrupt = "8 mins", prop.interrupt = 0.25, epoch = "dominant.epoch", return.indices = FALSE, @@ -37,12 +37,12 @@ calculated.} \item{min.length}{The minimum length of a pulse. Can be either a \link[lubridate]{duration} or a string. If it is a string, it needs to be a valid \link[lubridate]{duration} string, e.g., \code{"1 day"} or \code{"10 sec"}. Defaults to -\code{"8 mins"} as in Wilson et al. (2018).} +\code{"2 mins"} as in Wilson et al. (2018).} \item{max.interrupt}{Maximum length of each episode of interruptions. Can be either a \link[lubridate]{duration} or a string. If it is a string, it needs to be a valid \link[lubridate]{duration} string, e.g., \code{"1 day"} or \code{"10 sec"}. Defaults to -\code{"2 mins"} as in Wilson et al. (2018).} +\code{"8 mins"} as in Wilson et al. (2018).} \item{prop.interrupt}{Numeric value between \code{0} and \code{1} specifying the maximum proportion of the total number of interruptions. Defaults to \code{0.25}