diff --git a/R/RcppExports.R b/R/RcppExports.R index 3504261..297d31b 100644 --- a/R/RcppExports.R +++ b/R/RcppExports.R @@ -96,7 +96,7 @@ minmax_run <- function(x, metric = "min", na_rm = TRUE) { #' vector defines the indexes which data is computed at. #' #' @param na_rm `logical` single value (default `na_rm = TRUE`) - -#' if `TRUE` sum is calculating excluding `NA`. +#' if `TRUE`, missing values are removed before calculation. #' #' @inheritParams runner #' diff --git a/man/max_run.Rd b/man/max_run.Rd index 6a31449..7a3c928 100755 --- a/man/max_run.Rd +++ b/man/max_run.Rd @@ -36,7 +36,7 @@ instead of \code{length(x)}. A single time-interval string (e.g. \code{"month"}) generates a regular sequence over the range of \code{idx}.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} diff --git a/man/mean_run.Rd b/man/mean_run.Rd index be3d288..9d04100 100755 --- a/man/mean_run.Rd +++ b/man/mean_run.Rd @@ -36,7 +36,7 @@ Vector of any size and any value defining output data points. Values of the vector defines the indexes which data is computed at.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} diff --git a/man/min_run.Rd b/man/min_run.Rd index 6ca1d0f..e565866 100755 --- a/man/min_run.Rd +++ b/man/min_run.Rd @@ -36,7 +36,7 @@ instead of \code{length(x)}. A single time-interval string (e.g. \code{"month"}) generates a regular sequence over the range of \code{idx}.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} diff --git a/man/minmax_run.Rd b/man/minmax_run.Rd index 5b2aef1..7b3f624 100644 --- a/man/minmax_run.Rd +++ b/man/minmax_run.Rd @@ -13,7 +13,7 @@ input data.} \item{metric}{\code{character} what to return, minimum or maximum} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} } \value{ list. diff --git a/man/runner.Rd b/man/runner.Rd index 2d58d89..f770ff3 100644 --- a/man/runner.Rd +++ b/man/runner.Rd @@ -115,7 +115,7 @@ generates a regular sequence over the range of \code{idx}.} If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} \item{simplify}{(\code{logical} or \code{character})\cr -Simplify result like \code{\link[base:lapply]{base::sapply()}}. \code{TRUE} returns vector/matrix, +Simplify result like \code{\link[base:sapply]{base::sapply()}}. \code{TRUE} returns vector/matrix, \code{"array"} may return a higher-dimensional array.} \item{cl}{(\code{cluster}) \emph{experimental}\cr @@ -276,7 +276,7 @@ and shifts at each position. Pass a \code{\link[parallel:makeCluster]{parallel::makeCluster()}} object via \code{cl} to run windows in parallel. Objects referenced inside \code{f} (other than its arguments) must -be exported with \code{\link[parallel:clusterApply]{parallel::clusterExport()}} beforehand. Parallel +be exported with \code{\link[parallel:clusterExport]{parallel::clusterExport()}} beforehand. Parallel execution adds overhead and is only beneficial for expensive computations. } } diff --git a/man/streak_run.Rd b/man/streak_run.Rd index d638040..8c672e1 100755 --- a/man/streak_run.Rd +++ b/man/streak_run.Rd @@ -35,7 +35,7 @@ instead of \code{length(x)}. A single time-interval string (e.g. \code{"month"}) generates a regular sequence over the range of \code{idx}.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} diff --git a/man/sum_run.Rd b/man/sum_run.Rd index b2267da..5523aa5 100755 --- a/man/sum_run.Rd +++ b/man/sum_run.Rd @@ -36,7 +36,7 @@ Vector of any size and any value defining output data points. Values of the vector defines the indexes which data is computed at.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} diff --git a/man/which_run.Rd b/man/which_run.Rd index 11c8a2b..5e4f7ff 100644 --- a/man/which_run.Rd +++ b/man/which_run.Rd @@ -40,7 +40,7 @@ generates a regular sequence over the range of \code{idx}.} index is returned from the window.} \item{na_rm}{\code{logical} single value (default \code{na_rm = TRUE}) - -if \code{TRUE} sum is calculating excluding \code{NA}.} +if \code{TRUE}, missing values are removed before calculation.} \item{na_pad}{(\code{logical})\cr If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.}