From 63aa6d0cc7c00484a703fa64c002845ee6b7777b Mon Sep 17 00:00:00 2001 From: sorhawell Date: Fri, 20 Oct 2023 21:31:27 +0200 Subject: [PATCH] revert braces changes --- R/expr__expr.R | 41 ++++++++++++++++++------------------ R/extendr-wrappers.R | 2 +- R/series__series.R | 12 +++++------ man/Expr_cumcount.Rd | 2 +- man/Expr_cummin.Rd | 4 ++-- man/Expr_cumprod.Rd | 2 +- man/Expr_cumsum.Rd | 2 +- man/Expr_inspect.Rd | 2 +- man/Expr_rolling_max.Rd | 2 +- man/Expr_rolling_mean.Rd | 2 +- man/Expr_rolling_median.Rd | 2 +- man/Expr_rolling_min.Rd | 2 +- man/Expr_rolling_quantile.Rd | 2 +- man/Expr_rolling_std.Rd | 8 +++---- man/Expr_rolling_sum.Rd | 2 +- man/Expr_rolling_var.Rd | 2 +- man/Expr_sum.Rd | 2 +- man/Series_cumsum.Rd | 2 +- man/Series_max.Rd | 2 +- man/Series_mean.Rd | 2 +- man/Series_median.Rd | 2 +- man/Series_min.Rd | 2 +- man/Series_sum.Rd | 2 +- 23 files changed, 51 insertions(+), 52 deletions(-) diff --git a/R/expr__expr.R b/R/expr__expr.R index 8da5ecab7..11558c3a9 100644 --- a/R/expr__expr.R +++ b/R/expr__expr.R @@ -1373,7 +1373,7 @@ Expr_rechunk = "use_extendr_wrapper" #' @aliases Expr_cumsum #' @name Expr_cumsum #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' @format NULL #' @examples @@ -1394,7 +1394,7 @@ Expr_cumsum = function(reverse = FALSE) { #' @aliases cumprod #' @name Expr_cumprod #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' #' @format NULL @@ -1415,7 +1415,7 @@ Expr_cumprod = function(reverse = FALSE) { #' @aliases cummin #' @name Expr_cummin #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' #' See Inf,NaN,NULL,Null/NA translations here \code{\link[polars]{docs_translations}} @@ -1437,7 +1437,7 @@ Expr_cummin = function(reverse = FALSE) { #' @aliases cummin #' @name Expr_cummin #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' #' See Inf,NaN,NULL,Null/NA translations here \code{\link[polars]{docs_translations}} @@ -1460,7 +1460,7 @@ Expr_cummax = function(reverse = FALSE) { #' @aliases cumcount #' @name Expr_cumcount #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' #' cumcount does not seem to count within lists. @@ -2065,7 +2065,7 @@ Expr_nan_min = "use_extendr_wrapper" #' Get sum value #' #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' #' @return Expr @@ -2664,7 +2664,7 @@ Expr_reinterpret = function(signed = TRUE) { #' The printing will happen when the expression evaluates, not when it is formed. #' @param fmt format string, should contain one set of `{}` where object will be printed #' This formatting mimics python "string".format() use in pypolars. The string can -#' contain any thing but should have exactly one set of curly bracket `{}`. +#' contain any thing but should have exactly one set of curly bracket {}. #' @return Expr #' @aliases inspect #' @examples @@ -2782,7 +2782,7 @@ prepare_rolling_window_args = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' @@ -2848,7 +2848,7 @@ Expr_rolling_min = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' @@ -2914,7 +2914,7 @@ Expr_rolling_max = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' @details #' This functionality is experimental and may change without it being considered a @@ -2980,7 +2980,7 @@ Expr_rolling_mean = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' @details #' This functionality is experimental and may change without it being considered a @@ -3042,10 +3042,10 @@ Expr_rolling_sum = function( #' @param center #' Set the labels at the center of the window #' @param by -#' If the `window_size` is temporal for instance `"5h"` or `"3s"`, you must +#' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must -#' be of DataType: Date or DateTime. -#' @param closed string option `c("left", "right", "both", "none")`. +#' be of dtype `{Date, Datetime}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' @@ -3066,14 +3066,13 @@ Expr_rolling_std = function( min_periods = NULL, center = FALSE, # :bool, by = NULL, # : Nullable, - closed = c("left", "right", "both", "none") + closed = "left" # ;: Nullable, ) { wargs = prepare_rolling_window_args(window_size, min_periods) - .pr$Expr$rolling_std( + unwrap(.pr$Expr$rolling_std( self, wargs$window_size, weights, wargs$min_periods, center, by, closed - ) |> - unwrap("in $rolling_std(): ") + )) } #' Rolling var @@ -3112,7 +3111,7 @@ Expr_rolling_std = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' @@ -3178,7 +3177,7 @@ Expr_rolling_var = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' @@ -3249,7 +3248,7 @@ Expr_rolling_median = function( #' If the `window_size` is temporal for instance `"5h"` or `"3s`, you must #' set the column that will be used to determine the windows. This column must #' be of dtype `{Date, Datetime}` -#' @param closed String options `{'left', 'right', 'both', 'none'}` +#' @param closed : {'left', 'right', 'both', 'none'} #' Define whether the temporal window interval is closed or not. #' #' diff --git a/R/extendr-wrappers.R b/R/extendr-wrappers.R index d56e7fa23..82a0a0037 100644 --- a/R/extendr-wrappers.R +++ b/R/extendr-wrappers.R @@ -985,7 +985,7 @@ LazyFrame$sink_parquet <- function(path, compression_method, compression_level, LazyFrame$sink_ipc <- function(path, compression_method, maintain_order) .Call(wrap__LazyFrame__sink_ipc, self, path, compression_method, maintain_order) -LazyFrame$sink_csv <- function(path, has_header, separator, line_terminator, quote, batch_size, datetime_format, date_format, time_format, float_precision, null_values, quote_style, maintain_order) .Call(wrap__LazyFrame__sink_csv, self, path, has_header, separator, line_terminator, quote, batch_size, datetime_format, date_format, time_format, float_precision, null_values, quote_style, maintain_order) +LazyFrame$sink_csv <- function(path, has_header, separator, line_terminator, quote, batch_size, datetime_format, date_format, time_format, float_precision, null_value, quote_style, maintain_order) .Call(wrap__LazyFrame__sink_csv, self, path, has_header, separator, line_terminator, quote, batch_size, datetime_format, date_format, time_format, float_precision, null_value, quote_style, maintain_order) LazyFrame$first <- function() .Call(wrap__LazyFrame__first, self) diff --git a/R/series__series.R b/R/series__series.R index f7896224b..0b602c47f 100644 --- a/R/series__series.R +++ b/R/series__series.R @@ -572,7 +572,7 @@ Series_clone = "use_extendr_wrapper" #' @aliases Series_cumsum #' @name Series_cumsum #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, NaN, 4, Inf))$cumsum() @@ -586,7 +586,7 @@ Series_cumsum = function(reverse = FALSE) { #' @return R scalar value #' @keywords Series #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before summing to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, 5))$sum() # a NA is dropped always @@ -601,7 +601,7 @@ Series_sum = function() { #' @return R scalar value #' @keywords Series #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before meanming to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, 5))$mean() # a NA is dropped always @@ -616,7 +616,7 @@ Series_mean = function() { #' @return R scalar value #' @keywords Series #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before medianming to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, 5))$median() # a NA is dropped always @@ -631,7 +631,7 @@ Series_median = function() { #' @return R scalar value #' @keywords Series #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before maxming to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, 5))$max() # a NA is dropped always @@ -646,7 +646,7 @@ Series_max = function() { #' @return R scalar value #' @keywords Series #' @details -#' Dtypes in `{Int8, UInt8, Int16, UInt16}` are cast to +#' Dtypes in {Int8, UInt8, Int16, UInt16} are cast to #' Int64 before taking the min to prevent overflow issues. #' @examples #' pl$Series(c(1:2, NA, 3, 5))$min() # a NA is dropped always diff --git a/man/Expr_cumcount.Rd b/man/Expr_cumcount.Rd index 4ae4ff14d..0db25280e 100644 --- a/man/Expr_cumcount.Rd +++ b/man/Expr_cumcount.Rd @@ -18,7 +18,7 @@ Get an array with the cumulative count computed at every element. Counting from 0 to len } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. cumcount does not seem to count within lists. diff --git a/man/Expr_cummin.Rd b/man/Expr_cummin.Rd index febc059f2..62ad143c8 100644 --- a/man/Expr_cummin.Rd +++ b/man/Expr_cummin.Rd @@ -24,12 +24,12 @@ Get an array with the cumulative min computed at every element. Get an array with the cumulative max computed at every element. } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. See Inf,NaN,NULL,Null/NA translations here \code{\link[polars]{docs_translations}} -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. See Inf,NaN,NULL,Null/NA translations here \code{\link[polars]{docs_translations}} diff --git a/man/Expr_cumprod.Rd b/man/Expr_cumprod.Rd index bf101a40e..27a8af3fb 100644 --- a/man/Expr_cumprod.Rd +++ b/man/Expr_cumprod.Rd @@ -17,7 +17,7 @@ Expr Get an array with the cumulative product computed at every element. } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. } \examples{ diff --git a/man/Expr_cumsum.Rd b/man/Expr_cumsum.Rd index 0d6786e94..c21021528 100644 --- a/man/Expr_cumsum.Rd +++ b/man/Expr_cumsum.Rd @@ -16,7 +16,7 @@ Expr Get an array with the cumulative sum computed at every element. } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. } \examples{ diff --git a/man/Expr_inspect.Rd b/man/Expr_inspect.Rd index f5c7807ed..bd45bc60b 100644 --- a/man/Expr_inspect.Rd +++ b/man/Expr_inspect.Rd @@ -10,7 +10,7 @@ Expr_inspect(fmt = "{}") \arguments{ \item{fmt}{format string, should contain one set of \code{{}} where object will be printed This formatting mimics python "string".format() use in pypolars. The string can -contain any thing but should have exactly one set of curly bracket \code{{}}.} +contain any thing but should have exactly one set of curly bracket {}.} } \value{ Expr diff --git a/man/Expr_rolling_max.Rd b/man/Expr_rolling_max.Rd index a5d50fd77..9a9791af9 100644 --- a/man/Expr_rolling_max.Rd +++ b/man/Expr_rolling_max.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_mean.Rd b/man/Expr_rolling_mean.Rd index 89d413520..e2e3e0401 100644 --- a/man/Expr_rolling_mean.Rd +++ b/man/Expr_rolling_mean.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_median.Rd b/man/Expr_rolling_median.Rd index a5f2c4365..157a9b2f7 100644 --- a/man/Expr_rolling_median.Rd +++ b/man/Expr_rolling_median.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_min.Rd b/man/Expr_rolling_min.Rd index 633f90362..a223eeedc 100644 --- a/man/Expr_rolling_min.Rd +++ b/man/Expr_rolling_min.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_quantile.Rd b/man/Expr_rolling_quantile.Rd index e5284056c..95ad33667 100644 --- a/man/Expr_rolling_quantile.Rd +++ b/man/Expr_rolling_quantile.Rd @@ -50,7 +50,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_std.Rd b/man/Expr_rolling_std.Rd index b42617e09..dec916d0a 100644 --- a/man/Expr_rolling_std.Rd +++ b/man/Expr_rolling_std.Rd @@ -10,7 +10,7 @@ Expr_rolling_std( min_periods = NULL, center = FALSE, by = NULL, - closed = c("left", "right", "both", "none") + closed = "left" ) } \arguments{ @@ -40,11 +40,11 @@ a result. If None, it will be set equal to window size.} \item{center}{Set the labels at the center of the window} -\item{by}{If the \code{window_size} is temporal for instance \code{"5h"} or \code{"3s"}, you must +\item{by}{If the \code{window_size} is temporal for instance \code{"5h"} or \verb{"3s}, you must set the column that will be used to determine the windows. This column must -be of DataType: Date or DateTime.} +be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{string option \code{c("left", "right", "both", "none")}. +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_sum.Rd b/man/Expr_rolling_sum.Rd index 5e1db9a98..4fda3efe1 100644 --- a/man/Expr_rolling_sum.Rd +++ b/man/Expr_rolling_sum.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_rolling_var.Rd b/man/Expr_rolling_var.Rd index b9bbdf487..3d0bd8850 100644 --- a/man/Expr_rolling_var.Rd +++ b/man/Expr_rolling_var.Rd @@ -44,7 +44,7 @@ a result. If None, it will be set equal to window size.} set the column that will be used to determine the windows. This column must be of dtype \verb{\{Date, Datetime\}}} -\item{closed}{String options \verb{\{'left', 'right', 'both', 'none'\}} +\item{closed}{: {'left', 'right', 'both', 'none'} Define whether the temporal window interval is closed or not.} } \value{ diff --git a/man/Expr_sum.Rd b/man/Expr_sum.Rd index 2a3ce301b..68c84cb34 100644 --- a/man/Expr_sum.Rd +++ b/man/Expr_sum.Rd @@ -13,7 +13,7 @@ Expr Get sum value } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. } \examples{ diff --git a/man/Series_cumsum.Rd b/man/Series_cumsum.Rd index df997c19d..b5668604e 100644 --- a/man/Series_cumsum.Rd +++ b/man/Series_cumsum.Rd @@ -16,7 +16,7 @@ Series Get an array with the cumulative sum computed at every element. } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. } \examples{ diff --git a/man/Series_max.Rd b/man/Series_max.Rd index 492108215..873fa3f72 100644 --- a/man/Series_max.Rd +++ b/man/Series_max.Rd @@ -13,7 +13,7 @@ R scalar value Reduce Series with max } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before maxming to prevent overflow issues. } \examples{ diff --git a/man/Series_mean.Rd b/man/Series_mean.Rd index 89b258cd9..9f1f4fba0 100644 --- a/man/Series_mean.Rd +++ b/man/Series_mean.Rd @@ -13,7 +13,7 @@ R scalar value Reduce Series with mean } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before meanming to prevent overflow issues. } \examples{ diff --git a/man/Series_median.Rd b/man/Series_median.Rd index 1c7302f5f..d02454fa0 100644 --- a/man/Series_median.Rd +++ b/man/Series_median.Rd @@ -13,7 +13,7 @@ R scalar value Reduce Series with median } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before medianming to prevent overflow issues. } \examples{ diff --git a/man/Series_min.Rd b/man/Series_min.Rd index dab6f5015..d8602f1af 100644 --- a/man/Series_min.Rd +++ b/man/Series_min.Rd @@ -13,7 +13,7 @@ R scalar value Reduce Series with min } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before taking the min to prevent overflow issues. } \examples{ diff --git a/man/Series_sum.Rd b/man/Series_sum.Rd index ea6b86239..55ae68b60 100644 --- a/man/Series_sum.Rd +++ b/man/Series_sum.Rd @@ -13,7 +13,7 @@ R scalar value Reduce Series with sum } \details{ -Dtypes in \verb{\{Int8, UInt8, Int16, UInt16\}} are cast to +Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues. } \examples{