diff --git a/R/expr__expr.R b/R/expr__expr.R index 59e115763..2389b95ba 100644 --- a/R/expr__expr.R +++ b/R/expr__expr.R @@ -2283,22 +2283,7 @@ prepare_rolling_window_args = function( #' length `window_size` will traverse the array. The values that fill this window #' will (optionally) be multiplied with the weights given by the `weight` vector. #' -#' @param window_size -#' The length of the window. Can be a fixed integer size, or a dynamic temporal -#' size indicated by the following string language: -#' - 1ns (1 nanosecond) -#' - 1us (1 microsecond) -#' - 1ms (1 millisecond) -#' - 1s (1 second) -#' - 1m (1 minute) -#' - 1h (1 hour) -#' - 1d (1 day) -#' - 1w (1 week) -#' - 1mo (1 calendar month) -#' - 1y (1 calendar year) -#' - 1i (1 index count) -#' If the dynamic string language is used, the `by` and `closed` arguments must -#' also be set. +#' @param window_size Integer specifying the length of the window. #' @inherit Expr_rolling params return #' @param weights An optional slice with the same length as the window that will #' be multiplied elementwise with the values in the window. @@ -2333,6 +2318,22 @@ Expr_rolling_min = function( #' @inheritParams Expr_rolling #' @param by This column must of dtype [`Date`][pl_date] or #' [`Datetime`][DataType_Datetime]. +#' @param window_size +#' The length of the window. Can be a fixed integer size, or a dynamic temporal +#' size indicated by the following string language: +#' - 1ns (1 nanosecond) +#' - 1us (1 microsecond) +#' - 1ms (1 millisecond) +#' - 1s (1 second) +#' - 1m (1 minute) +#' - 1h (1 hour) +#' - 1d (1 day) +#' - 1w (1 week) +#' - 1mo (1 calendar month) +#' - 1y (1 calendar year) +#' - 1i (1 index count) +#' If the dynamic string language is used, the `by` and `closed` arguments must +#' also be set. #' #' @examples #' df_temporal = pl$DataFrame( diff --git a/man/Expr_rolling_max.Rd b/man/Expr_rolling_max.Rd index a2991e4f8..fcaf20873 100644 --- a/man/Expr_rolling_max.Rd +++ b/man/Expr_rolling_max.Rd @@ -13,23 +13,7 @@ Expr_rolling_max( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_mean.Rd b/man/Expr_rolling_mean.Rd index 4aa2ca60f..6ec466fd3 100644 --- a/man/Expr_rolling_mean.Rd +++ b/man/Expr_rolling_mean.Rd @@ -13,23 +13,7 @@ Expr_rolling_mean( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_median.Rd b/man/Expr_rolling_median.Rd index eb865bb01..5ff2485f7 100644 --- a/man/Expr_rolling_median.Rd +++ b/man/Expr_rolling_median.Rd @@ -12,23 +12,7 @@ Expr_rolling_median( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_min.Rd b/man/Expr_rolling_min.Rd index 4b2416332..b41334cca 100644 --- a/man/Expr_rolling_min.Rd +++ b/man/Expr_rolling_min.Rd @@ -13,23 +13,7 @@ Expr_rolling_min( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_quantile.Rd b/man/Expr_rolling_quantile.Rd index d2c484853..b24a25c30 100644 --- a/man/Expr_rolling_quantile.Rd +++ b/man/Expr_rolling_quantile.Rd @@ -20,23 +20,7 @@ Expr_rolling_quantile( \item{interpolation}{String, one of \code{"nearest"}, \code{"higher"}, \code{"lower"}, \code{"midpoint"}, \code{"linear"}.} -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_skew.Rd b/man/Expr_rolling_skew.Rd index 14cb82307..9d7365231 100644 --- a/man/Expr_rolling_skew.Rd +++ b/man/Expr_rolling_skew.Rd @@ -7,23 +7,7 @@ Expr_rolling_skew(window_size, bias = TRUE) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{bias}{If \code{FALSE}, the calculations are corrected for statistical bias.} } diff --git a/man/Expr_rolling_std.Rd b/man/Expr_rolling_std.Rd index f30cf9084..793c57958 100644 --- a/man/Expr_rolling_std.Rd +++ b/man/Expr_rolling_std.Rd @@ -14,23 +14,7 @@ Expr_rolling_std( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_sum.Rd b/man/Expr_rolling_sum.Rd index d032eee53..0ded27b09 100644 --- a/man/Expr_rolling_sum.Rd +++ b/man/Expr_rolling_sum.Rd @@ -12,23 +12,7 @@ Expr_rolling_sum( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.} diff --git a/man/Expr_rolling_var.Rd b/man/Expr_rolling_var.Rd index 5d4472dec..c36a9e543 100644 --- a/man/Expr_rolling_var.Rd +++ b/man/Expr_rolling_var.Rd @@ -14,23 +14,7 @@ Expr_rolling_var( ) } \arguments{ -\item{window_size}{The length of the window. Can be a fixed integer size, or a dynamic temporal -size indicated by the following string language: -\itemize{ -\item 1ns (1 nanosecond) -\item 1us (1 microsecond) -\item 1ms (1 millisecond) -\item 1s (1 second) -\item 1m (1 minute) -\item 1h (1 hour) -\item 1d (1 day) -\item 1w (1 week) -\item 1mo (1 calendar month) -\item 1y (1 calendar year) -\item 1i (1 index count) -If the dynamic string language is used, the \code{by} and \code{closed} arguments must -also be set. -}} +\item{window_size}{Integer specifying the length of the window.} \item{weights}{An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.}