Skip to content

Commit

Permalink
docs: adjust arg window_size for $rolling_*() functions (#1143)
Browse files Browse the repository at this point in the history
  • Loading branch information
etiennebacher committed Jun 13, 2024
1 parent 0735544 commit 6eac27a
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 169 deletions.
33 changes: 17 additions & 16 deletions R/expr__expr.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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(
Expand Down
18 changes: 1 addition & 17 deletions man/Expr_rolling_max.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_mean.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_median.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_min.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_quantile.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_skew.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_std.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_sum.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 1 addition & 17 deletions man/Expr_rolling_var.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6eac27a

Please sign in to comment.