diff --git a/R/Field.R b/R/Field.R index a96c94af9..67dabd026 100644 --- a/R/Field.R +++ b/R/Field.R @@ -18,12 +18,10 @@ #' #' `$name = "new_name"` sets the name of the Field. #' -#' @aliases RField_class RPolarsRField -#' #' @param name Field name #' @param datatype [DataType][pl_dtypes] #' -#' @return An [RPolarsRField] object containing its name and its +#' @return An object of class `"RPolarsRField"` containing its name and its #' [data type][pl_dtypes]. #' # Named like this because R cannot have two man pages called "pl_Field" and diff --git a/R/datatype.R b/R/datatype.R index 5d098696c..dda7996c0 100644 --- a/R/datatype.R +++ b/R/datatype.R @@ -85,12 +85,15 @@ print.RPolarsDataType = function(x, ...) { "!=.RPolarsDataType" = function(e1, e2) e1$ne(e2) -#' check if x is a valid RPolarsDataType -#' @name same_outer_datatype -#' @param lhs an RPolarsDataType -#' @param rhs an RPolarsDataType +#' Check if two DataTypes share the same outer DataType +#' +#' +#' @param lhs RPolarsDataType +#' @param rhs RPolarsDataType +#' #' @noRd -#' @return bool TRUE if outer datatype is the same. +#' @name same_outer_datatype +#' @return A logical. #' @examples #' # TRUE #' pl$same_outer_dt(pl$Datetime("us"), pl$Datetime("ms")) @@ -103,20 +106,15 @@ pl_same_outer_dt = function(lhs, rhs) { } -#' DataType_new (simple DataType's) -#' @noRd -#' @description Create a new flag like DataType -#' @param str name of DataType to create +#' Create a new DataType (internal) +#' +#' @param str Name of DataType to create +#' #' @details #' This function is mainly used in `zzz.R` `.onLoad` to instantiate singletons of all #' flag-like DataType. #' -#' Non-flag like DataType called composite DataTypes also carries extra information -#' e.g. Datetime a timeunit and a TimeZone, or List which recursively carries another DataType -#' inside. Composite DataTypes use DataType constructors. -#' -#' Any DataType can be found in pl$dtypes -#' +#' @noRd #' @return DataType #' @examples #' .pr$env$DataType_new("Int64") @@ -124,20 +122,16 @@ DataType_new = function(str) { .pr$DataType$new(str) } -#' DataType_constructors (composite DataType's) -#' @description List of all composite DataType constructors -#' @noRd +#' DataType_constructors (internal) +#' +#' List of all composite DataType constructors +#' #' @details #' This list is mainly used in `zzz.R` `.onLoad` to instantiate singletons of all #' flag-like DataTypes. #' -#' Non-flag like DataType called composite DataTypes also carries extra information -#' e.g. Datetime a timeunit and a TimeZone, or List which recursively carries another DataType -#' inside. Composite DataTypes use DataType constructors. -#' -#' Any DataType can be found in pl$dtypes -#' #' @return DataType +#' @noRd #' @examples #' # constructors are finally available via pl$... or pl$dtypes$... #' pl$List(pl$List(pl$Int64)) @@ -145,9 +139,9 @@ DataType_constructors = function() { list( Array = DataType_Array, Categorical = DataType_Categorical, - Enum = DataType_Enum, Datetime = DataType_Datetime, Duration = DataType_Duration, + Enum = DataType_Enum, List = DataType_List, Struct = DataType_Struct ) @@ -182,9 +176,10 @@ DataType_Datetime = function(time_unit = "us", time_zone = NULL) { time_zone ) |> Err_plain() |> - unwrap("in $Datetime():") + unwrap("in pl$Datetime():") } - unwrap(.pr$DataType$new_datetime(time_unit, time_zone)) + .pr$DataType$new_datetime(time_unit, time_zone) |> + unwrap("in pl$Datetime():") } #' Data type representing a time duration @@ -287,6 +282,7 @@ DataType_Struct = function(...) { #' @param datatype An inner DataType. The default is `"Unknown"` and is only a #' placeholder for when inner DataType does not matter, e.g. as used in example. #' @param width The length of the arrays. +#' #' @return An array DataType with an inner DataType #' @examples #' # basic Array @@ -308,10 +304,10 @@ DataType_Array = function(datatype = "unknown", width) { } #' Create List DataType -#' @keywords pl -#' @param datatype an inner DataType, default is "Unknown" (placeholder for when inner DataType -#' does not matter, e.g. as used in example) -#' @return a list DataType with an inner DataType +#' +#' @param datatype The inner DataType. +#' +#' @return A list DataType with an inner DataType #' @examples #' # some nested List #' pl$List(pl$List(pl$Boolean)) diff --git a/R/expr__array.R b/R/expr__array.R index 79cc392ab..29df51922 100644 --- a/R/expr__array.R +++ b/R/expr__array.R @@ -1,7 +1,6 @@ #' Sum all elements in an array #' #' @return Expr -#' @aliases arr_sum #' @examples #' df = pl$DataFrame( #' values = list(c(1, 2), c(3, 4), c(NA_real_, 6)), @@ -14,7 +13,6 @@ ExprArr_sum = function() .pr$Expr$arr_sum(self) #' #' @return Expr #' @inherit ExprStr_to_titlecase details -#' @aliases arr_max #' @examples #' df = pl$DataFrame( #' values = list(c(1, 2), c(3, 4), c(NA_real_, NA_real_)), @@ -29,7 +27,6 @@ ExprArr_max = function() { #' #' @inherit ExprStr_to_titlecase details #' @return Expr -#' @aliases arr_min #' @examples #' df = pl$DataFrame( #' values = list(c(1, 2), c(3, 4), c(NA_real_, NA_real_)), @@ -43,7 +40,6 @@ ExprArr_min = function() { #' Find the median in an array #' #' @return Expr -#' @aliases arr_median #' @examples #' df = pl$DataFrame( #' values = list(c(2, 1, 4), c(8.4, 3.2, 1)), @@ -58,7 +54,6 @@ ExprArr_median = function() { #' #' @inheritParams DataFrame_std #' @return Expr -#' @aliases arr_std #' @examples #' df = pl$DataFrame( #' values = list(c(2, 1, 4), c(8.4, 3.2, 1)), @@ -73,7 +68,6 @@ ExprArr_std = function(ddof = 1) { #' #' @inheritParams DataFrame_var #' @return Expr -#' @aliases arr_var #' @examples #' df = pl$DataFrame( #' values = list(c(2, 1, 4), c(8.4, 3.2, 1)), @@ -87,7 +81,6 @@ ExprArr_var = function(ddof = 1) { #' Sort values in an array #' #' @inheritParams Expr_sort -#' @aliases arr_sort #' @examples #' df = pl$DataFrame( #' values = list(c(2, 1), c(3, 4), c(NA_real_, 6)), @@ -99,7 +92,6 @@ ExprArr_sort = function(descending = FALSE, nulls_last = FALSE) .pr$Expr$arr_sor #' Reverse values in an array #' #' @return Expr -#' @aliases arr_reverse #' @examples #' df = pl$DataFrame( #' values = list(c(1, 2), c(3, 4), c(NA_real_, 6)), @@ -112,7 +104,6 @@ ExprArr_reverse = function() .pr$Expr$arr_reverse(self) #' #' @inheritParams Expr_unique #' @return Expr -#' @aliases arr_unique #' @examples #' df = pl$DataFrame( #' values = list(c(1, 1, 2), c(4, 4, 4), c(NA_real_, 6, 7)), @@ -154,7 +145,6 @@ ExprArr_get = function(index, ..., null_on_oob = TRUE) { #' as columns. #' #' @return Expr -#' @aliases arr_contains #' @examples #' df = pl$DataFrame( #' values = list(0:2, 4:6, c(NA_integer_, NA_integer_, NA_integer_)), @@ -177,7 +167,6 @@ ExprArr_contains = function(item) .pr$Expr$arr_contains(self, item) #' @inheritParams pl_concat_str #' #' @return Expr -#' @aliases arr_join #' @examples #' df = pl$DataFrame( #' values = list(c("a", "b", "c"), c("x", "y", "z"), c("e", NA, NA)), @@ -197,7 +186,6 @@ ExprArr_join = function(separator, ignore_nulls = FALSE) { #' Get the index of the minimal value in an array #' #' @return Expr -#' @aliases arr_arg_min #' @examples #' df = pl$DataFrame( #' values = list(1:2, 2:1), @@ -211,7 +199,6 @@ ExprArr_arg_min = function() .pr$Expr$arr_arg_min(self) #' Get the index of the maximal value in an array #' #' @return Expr -#' @aliases arr_arg_max #' @examples #' df = pl$DataFrame( #' values = list(1:2, 2:1), @@ -249,7 +236,6 @@ ExprArr_any = function() .pr$Expr$arr_any(self) #' @inheritParams ExprList_shift #' #' @return Expr -#' @aliases arr_shift #' @examples #' df = pl$DataFrame( #' values = list(1:3, c(2L, NA_integer_, 5L)), @@ -286,7 +272,6 @@ ExprArr_to_list = function() .pr$Expr$arr_to_list(self) #' @inheritParams ExprList_to_struct #' #' @return Expr -#' @aliases arr_to_struct #' @examples #' df = pl$DataFrame( #' values = list(1:3, c(2L, NA_integer_, 5L)), diff --git a/R/expr__categorical.R b/R/expr__categorical.R index b14a95e59..0eaad3a39 100644 --- a/R/expr__categorical.R +++ b/R/expr__categorical.R @@ -1,13 +1,13 @@ #' Set Ordering #' -#' @aliases expr_cat_set_ordering -#' @description Determine how this categorical series should be sorted. -#' @keywords ExprCat +#' Determine how this categorical series should be sorted. +#' #' @param ordering string either 'physical' or 'lexical' -#' - 'physical' -> Use the physical representation of the categories to -#' determine the order (default). -#' - 'lexical' -> Use the string values to determine the ordering. -#' @return bool: TRUE if equal +#' - `"physical"`: use the physical representation of the categories to +#' determine the order (default). +#' - `"lexical"`: use the string values to determine the order. +#' +#' @return An Expr of datatype Categorical #' @examples #' df = pl$DataFrame( #' cats = factor(c("z", "z", "k", "a", "b")), @@ -24,13 +24,13 @@ #' pl$col("cats")$cat$set_ordering("physical") #' )$sort("cats", "vals") ExprCat_set_ordering = function(ordering) { - .pr$Expr$cat_set_ordering(self, ordering) |> unwrap("in $cat$set_ordering:") + .pr$Expr$cat_set_ordering(self, ordering) |> + unwrap("in $cat$set_ordering:") } #' Get the categories stored in this data type #' -#' @keywords ExprCat #' @return A polars DataFrame with the categories for each categorical Series. #' @examples #' df = pl$DataFrame( diff --git a/R/expr__list.R b/R/expr__list.R index c02d7e438..3c9c1d9a4 100644 --- a/R/expr__list.R +++ b/R/expr__list.R @@ -4,7 +4,7 @@ #' total. #' #' @return Expr -#' @aliases list_len +#' #' @examples #' df = pl$DataFrame(list(list_of_strs = list(c("a", "b", NA), "c"))) #' df$with_columns(len_list = pl$col("list_of_strs")$list$len()) @@ -13,7 +13,7 @@ ExprList_len = function() .pr$Expr$list_len(self) #' Sum all elements in a list #' #' @return Expr -#' @aliases list_sum +#' #' @examples #' df = pl$DataFrame(values = list(c(1, 2, 3, NA), c(2, 3), NA_real_)) #' df$with_columns(sum = pl$col("values")$list$sum()) @@ -22,7 +22,7 @@ ExprList_sum = function() .pr$Expr$list_sum(self) #' Find the maximum value in a list #' #' @return Expr -#' @aliases list_max +#' #' @examples #' df = pl$DataFrame(values = list(c(1, 2, 3, NA), c(2, 3), NA_real_)) #' df$with_columns(max = pl$col("values")$list$max()) @@ -31,7 +31,7 @@ ExprList_max = function() .pr$Expr$list_max(self) #' Find the minimum value in a list #' #' @return Expr -#' @aliases list_min +#' #' @examples #' df = pl$DataFrame(values = list(c(1, 2, 3, NA), c(2, 3), NA_real_)) #' df$with_columns(min = pl$col("values")$list$min()) @@ -40,7 +40,7 @@ ExprList_min = function() .pr$Expr$list_min(self) #' Compute the mean value of a list #' #' @return Expr -#' @aliases list_mean +#' #' @examples #' df = pl$DataFrame(values = list(c(1, 2, 3, NA), c(2, 3), NA_real_)) #' df$with_columns(mean = pl$col("values")$list$mean()) @@ -50,7 +50,7 @@ ExprList_mean = function() .pr$Expr$list_mean(self) #' #' @param descending Sort values in descending order #' @return Expr -#' @aliases list_sort +#' #' @examples #' df = pl$DataFrame(values = list(c(NA, 2, 1, 3), c(Inf, 2, 3, NaN), NA_real_)) #' df$with_columns(sort = pl$col("values")$list$sort()) @@ -59,7 +59,7 @@ ExprList_sort = function(descending = FALSE) .pr$Expr$list_sort(self, descending #' Reverse values in a list #' #' @return Expr -#' @aliases list_reverse +#' #' @examples #' df = pl$DataFrame(values = list(c(1, 2, 3, NA), c(2, 3), NA_real_)) #' df$with_columns(reverse = pl$col("values")$list$reverse()) @@ -68,7 +68,7 @@ ExprList_reverse = function() .pr$Expr$list_reverse(self) #' Get unique values in a list #' #' @return Expr -#' @aliases list_unique +#' #' @examples #' df = pl$DataFrame(values = list(c(2, 2, NA), c(1, 2, 3), NA_real_)) #' df$with_columns(unique = pl$col("values")$list$unique()) @@ -77,7 +77,7 @@ ExprList_unique = function() .pr$Expr$list_unique(self) #' Get the number of unique values in a list #' #' @return Expr -#' @aliases list_n_unique +#' #' @examples #' df = pl$DataFrame(values = list(c(2, 2, NA), c(1, 2, 3), NA_real_)) #' df$with_columns(unique = pl$col("values")$list$n_unique()) @@ -89,7 +89,7 @@ ExprList_n_unique = function() .pr$Expr$list_n_unique(self) #' an Expr. #' #' @return Expr -#' @aliases list_concat +#' #' @examples #' df = pl$DataFrame( #' a = list("a", "x"), @@ -146,7 +146,7 @@ ExprList_get = function(index, ..., null_on_oob = TRUE) { #' @inheritParams ExprList_get #' #' @return Expr -#' @aliases list_gather +#' #' @examples #' df = pl$DataFrame( #' a = list(c(3, 2, 1), 1, c(1, 2)), @@ -193,7 +193,7 @@ ExprList_gather_every = function(n, offset = 0) { #' Get the first value in a list #' #' @return Expr -#' @aliases list_first +#' #' @examples #' df = pl$DataFrame(list(a = list(3:1, NULL, 1:2))) #' df$with_columns( @@ -207,7 +207,7 @@ ExprList_first = function() { #' Get the last value in a list #' #' @return Expr -#' @aliases list_last +#' #' @examples #' df = pl$DataFrame(list(a = list(3:1, NULL, 1:2))) #' df$with_columns( @@ -224,7 +224,7 @@ ExprList_last = function() { #' as columns. #' #' @return Expr -#' @aliases list_contains +#' #' @examples #' df = pl$DataFrame( #' a = list(3:1, NULL, 1:2), @@ -246,7 +246,7 @@ ExprList_contains = function(item) .pr$Expr$list_contains(self, wrap_e(item)) #' @inheritParams pl_concat_str #' #' @return Expr -#' @aliases list_join +#' #' @examples #' df = pl$DataFrame( #' s = list(c("a", "b", "c"), c("x", "y"), c("e", NA)), @@ -265,7 +265,7 @@ ExprList_join = function(separator, ignore_nulls = FALSE) { #' Get the index of the minimal value in list #' #' @return Expr -#' @aliases list_arg_min +#' #' @examples #' df = pl$DataFrame(list(s = list(1:2, 2:1))) #' df$with_columns( @@ -276,7 +276,7 @@ ExprList_arg_min = function() .pr$Expr$list_arg_min(self) #' Get the index of the maximal value in list #' #' @return Expr -#' @aliases list_arg_max +#' #' @examples #' df = pl$DataFrame(list(s = list(1:2, 2:1))) #' df$with_columns( @@ -297,7 +297,7 @@ ExprList_arg_max = function() .pr$Expr$list_arg_max(self) #' or `"drop"`. #' #' @return Expr -#' @aliases list_diff +#' #' @examples #' df = pl$DataFrame(list(s = list(1:4, c(10L, 2L, 1L)))) #' df$with_columns(diff = pl$col("s")$list$diff(2)) @@ -315,7 +315,7 @@ ExprList_diff = function(n = 1, null_behavior = c("ignore", "drop")) { #' Strings are *not* parsed as columns. #' #' @return Expr -#' @aliases list_shift +#' #' @examples #' df = pl$DataFrame( #' s = list(1:4, c(10L, 2L, 1L)), @@ -339,7 +339,7 @@ ExprList_shift = function(periods = 1) unwrap(.pr$Expr$list_shift(self, periods) #' the end of the list. Can be an Expr. Strings are parsed as column names. #' #' @return Expr -#' @aliases list_slice +#' #' @examples #' df = pl$DataFrame( #' s = list(1:4, c(10L, 2L, 1L)), @@ -364,7 +364,7 @@ ExprList_slice = function(offset, length = NULL) { #' are parsed as column names. #' #' @return Expr -#' @aliases list_head +#' #' @examples #' df = pl$DataFrame( #' s = list(1:4, c(10L, 2L, 1L)), @@ -384,7 +384,7 @@ ExprList_head = function(n = 5L) { #' are parsed as column names. #' #' @return Expr -#' @aliases list_tail +#' #' @examples #' df = pl$DataFrame( #' s = list(1:4, c(10L, 2L, 1L)), @@ -421,7 +421,7 @@ ExprList_tail = function(n = 5L) { #' evaluated, so you can leave this parameter unset. #' #' @return Expr -#' @aliases list_to_struct +#' #' @examples #' df = pl$DataFrame(list(a = list(1:2, 1:3))) #' @@ -465,7 +465,7 @@ ExprList_to_struct = function( #' do parallel execution per group. #' #' @return Expr -#' @aliases list_eval +#' #' @examples #' df = pl$DataFrame( #' a = list(c(1, 8, 3), c(3, 2), c(NA, NA, 1)), diff --git a/R/expr__string.R b/R/expr__string.R index f39f19d49..9dbfab284 100644 --- a/R/expr__string.R +++ b/R/expr__string.R @@ -118,10 +118,7 @@ ExprStr_strptime = function( #' Convert a String column into a Date column #' #' @inheritParams ExprStr_strptime -#' @format Format to use for conversion. Refer to -#' [the chrono crate documentation](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) -#' for the full specification. Example: `"%Y-%m-%d"`. -#' If `NULL` (default), the format is inferred from the data. +#' #' @return [Expr][Expr_class] of Date type #' @seealso #' - [`$str$strptime()`][ExprStr_strptime] @@ -142,10 +139,7 @@ ExprStr_to_date = function(format = NULL, ..., strict = TRUE, exact = TRUE, cach #' Convert a String column into a Time column #' #' @inheritParams ExprStr_strptime -#' @format Format to use for conversion. Refer to -#' [the chrono crate documentation](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) -#' for the full specification. Example: `"%H:%M:%S"`. -#' If `NULL` (default), the format is inferred from the data. +#' #' @return [Expr][Expr_class] of Time type #' @seealso #' - [`$str$strptime()`][ExprStr_strptime] diff --git a/R/expr__struct.R b/R/expr__struct.R index c1f08d156..a63a97129 100644 --- a/R/expr__struct.R +++ b/R/expr__struct.R @@ -1,11 +1,8 @@ -#' field +#' Retrieve one of the fields of this Struct as a new Series #' -#' @aliases expr_struct_field -#' @description Retrieve a ``Struct`` field as a new Series. -#' By default base 2. -#' @keywords ExprStruct -#' @param name string, the Name of the struct field to retrieve. -#' @return Expr: Series of same and name selected field. +#' @param name Name of the field. +#' +#' @return Expr of datatype Struct #' @examples #' df = pl$DataFrame( #' aaa = c(1, 2), @@ -26,15 +23,13 @@ ExprStruct_field = function(name) { } -#' rename fields +#' Rename the fields of the struct +#' +#' @param names Vector or list of strings given in the same order as the struct's +#' fields. Providing fewer names will drop the latter fields. If too many names +#' are given, the extra names are ignored. #' -#' @aliases expr_struct_rename_fields -#' @description Rename the fields of the struct. -#' By default base 2. -#' @keywords ExprStruct -#' @param names char vec or list of strings given in the same order as the struct's fields. -#' Providing fewer names will drop the latter fields. Providing too many names is ignored. -#' @return Expr: struct-series with new names for the fields +#' @return Expr of datatype Struct #' @examples #' df = pl$DataFrame( #' aaa = 1:2, @@ -48,7 +43,8 @@ ExprStruct_field = function(name) { #' ) #' df$unnest() ExprStruct_rename_fields = function(names) { - .pr$Expr$struct_rename_fields(self, names) |> unwrap("in $struct$rename_fields:") + .pr$Expr$struct_rename_fields(self, names) |> + unwrap("in $struct$rename_fields:") } #' Add or overwrite fields of this struct diff --git a/R/io_csv.R b/R/io_csv.R index fc70b3397..8c5f2bc21 100644 --- a/R/io_csv.R +++ b/R/io_csv.R @@ -1,7 +1,7 @@ #' New LazyFrame from CSV #' -#' @description #' Read a file from path into a polars LazyFrame. +#' #' @rdname IO_scan_csv #' #' @param source Path to a file or URL. It is possible to provide multiple paths diff --git a/man/DataType_List.Rd b/man/DataType_List.Rd index 3dc252744..f4f100766 100644 --- a/man/DataType_List.Rd +++ b/man/DataType_List.Rd @@ -7,11 +7,10 @@ DataType_List(datatype = "unknown") } \arguments{ -\item{datatype}{an inner DataType, default is "Unknown" (placeholder for when inner DataType -does not matter, e.g. as used in example)} +\item{datatype}{The inner DataType.} } \value{ -a list DataType with an inner DataType +A list DataType with an inner DataType } \description{ Create List DataType @@ -24,4 +23,3 @@ pl$List(pl$List(pl$Boolean)) maybe_List = pl$List(pl$UInt64) pl$same_outer_dt(maybe_List, pl$List()) } -\keyword{pl} diff --git a/man/ExprArr_arg_max.Rd b/man/ExprArr_arg_max.Rd index b910ad232..68929fbf0 100644 --- a/man/ExprArr_arg_max.Rd +++ b/man/ExprArr_arg_max.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_arg_max} \alias{ExprArr_arg_max} -\alias{arr_arg_max} \title{Get the index of the maximal value in an array} \usage{ ExprArr_arg_max() diff --git a/man/ExprArr_arg_min.Rd b/man/ExprArr_arg_min.Rd index 8dfabca24..ee94025f2 100644 --- a/man/ExprArr_arg_min.Rd +++ b/man/ExprArr_arg_min.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_arg_min} \alias{ExprArr_arg_min} -\alias{arr_arg_min} \title{Get the index of the minimal value in an array} \usage{ ExprArr_arg_min() diff --git a/man/ExprArr_contains.Rd b/man/ExprArr_contains.Rd index 849459243..259b6d17a 100644 --- a/man/ExprArr_contains.Rd +++ b/man/ExprArr_contains.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_contains} \alias{ExprArr_contains} -\alias{arr_contains} \title{Check if array contains a given value} \usage{ ExprArr_contains(item) diff --git a/man/ExprArr_join.Rd b/man/ExprArr_join.Rd index 5bca37acc..97837cd98 100644 --- a/man/ExprArr_join.Rd +++ b/man/ExprArr_join.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_join} \alias{ExprArr_join} -\alias{arr_join} \title{Join elements of an array} \usage{ ExprArr_join(separator, ignore_nulls = FALSE) diff --git a/man/ExprArr_max.Rd b/man/ExprArr_max.Rd index fe76a5059..c05c93b05 100644 --- a/man/ExprArr_max.Rd +++ b/man/ExprArr_max.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_max} \alias{ExprArr_max} -\alias{arr_max} \title{Find the maximum value in an array} \usage{ ExprArr_max() diff --git a/man/ExprArr_median.Rd b/man/ExprArr_median.Rd index 1ae68821e..21ef070a4 100644 --- a/man/ExprArr_median.Rd +++ b/man/ExprArr_median.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_median} \alias{ExprArr_median} -\alias{arr_median} \title{Find the median in an array} \usage{ ExprArr_median() diff --git a/man/ExprArr_min.Rd b/man/ExprArr_min.Rd index f4911012f..ed678a0ed 100644 --- a/man/ExprArr_min.Rd +++ b/man/ExprArr_min.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_min} \alias{ExprArr_min} -\alias{arr_min} \title{Find the minimum value in an array} \usage{ ExprArr_min() diff --git a/man/ExprArr_reverse.Rd b/man/ExprArr_reverse.Rd index 06d7c0281..6884c11d8 100644 --- a/man/ExprArr_reverse.Rd +++ b/man/ExprArr_reverse.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_reverse} \alias{ExprArr_reverse} -\alias{arr_reverse} \title{Reverse values in an array} \usage{ ExprArr_reverse() diff --git a/man/ExprArr_shift.Rd b/man/ExprArr_shift.Rd index d8a8e86d7..ffa390d00 100644 --- a/man/ExprArr_shift.Rd +++ b/man/ExprArr_shift.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_shift} \alias{ExprArr_shift} -\alias{arr_shift} \title{Shift array values by \code{n} indices} \usage{ ExprArr_shift(periods = 1) diff --git a/man/ExprArr_sort.Rd b/man/ExprArr_sort.Rd index ffdd3404e..e9d73677c 100644 --- a/man/ExprArr_sort.Rd +++ b/man/ExprArr_sort.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_sort} \alias{ExprArr_sort} -\alias{arr_sort} \title{Sort values in an array} \usage{ ExprArr_sort(descending = FALSE, nulls_last = FALSE) diff --git a/man/ExprArr_std.Rd b/man/ExprArr_std.Rd index 9207668ba..9ff251bbe 100644 --- a/man/ExprArr_std.Rd +++ b/man/ExprArr_std.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_std} \alias{ExprArr_std} -\alias{arr_std} \title{Find the standard deviation in an array} \usage{ ExprArr_std(ddof = 1) diff --git a/man/ExprArr_sum.Rd b/man/ExprArr_sum.Rd index 51d1254ae..7e5e46aa9 100644 --- a/man/ExprArr_sum.Rd +++ b/man/ExprArr_sum.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_sum} \alias{ExprArr_sum} -\alias{arr_sum} \title{Sum all elements in an array} \usage{ ExprArr_sum() diff --git a/man/ExprArr_to_struct.Rd b/man/ExprArr_to_struct.Rd index 26969198f..18d818fa5 100644 --- a/man/ExprArr_to_struct.Rd +++ b/man/ExprArr_to_struct.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_to_struct} \alias{ExprArr_to_struct} -\alias{arr_to_struct} \title{Convert array to struct} \usage{ ExprArr_to_struct(fields = NULL) diff --git a/man/ExprArr_unique.Rd b/man/ExprArr_unique.Rd index 9cc9d4833..28ce87f1c 100644 --- a/man/ExprArr_unique.Rd +++ b/man/ExprArr_unique.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_unique} \alias{ExprArr_unique} -\alias{arr_unique} \title{Get unique values in an array} \usage{ ExprArr_unique(maintain_order = FALSE) diff --git a/man/ExprArr_var.Rd b/man/ExprArr_var.Rd index 3d9695e16..912b1f88c 100644 --- a/man/ExprArr_var.Rd +++ b/man/ExprArr_var.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__array.R \name{ExprArr_var} \alias{ExprArr_var} -\alias{arr_var} \title{Find the variance in an array} \usage{ ExprArr_var(ddof = 1) diff --git a/man/ExprCat_get_categories.Rd b/man/ExprCat_get_categories.Rd index a772c1999..01b151af7 100644 --- a/man/ExprCat_get_categories.Rd +++ b/man/ExprCat_get_categories.Rd @@ -26,4 +26,3 @@ df$select( pl$col("vals")$cat$get_categories() ) } -\keyword{ExprCat} diff --git a/man/ExprCat_set_ordering.Rd b/man/ExprCat_set_ordering.Rd index 8a802fd35..0baf028ab 100644 --- a/man/ExprCat_set_ordering.Rd +++ b/man/ExprCat_set_ordering.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__categorical.R \name{ExprCat_set_ordering} \alias{ExprCat_set_ordering} -\alias{expr_cat_set_ordering} \title{Set Ordering} \usage{ ExprCat_set_ordering(ordering) @@ -10,13 +9,13 @@ ExprCat_set_ordering(ordering) \arguments{ \item{ordering}{string either 'physical' or 'lexical' \itemize{ -\item 'physical' -> Use the physical representation of the categories to +\item \code{"physical"}: use the physical representation of the categories to determine the order (default). -\item 'lexical' -> Use the string values to determine the ordering. +\item \code{"lexical"}: use the string values to determine the order. }} } \value{ -bool: TRUE if equal +An Expr of datatype Categorical } \description{ Determine how this categorical series should be sorted. @@ -37,4 +36,3 @@ df$with_columns( pl$col("cats")$cat$set_ordering("physical") )$sort("cats", "vals") } -\keyword{ExprCat} diff --git a/man/ExprList_arg_max.Rd b/man/ExprList_arg_max.Rd index be6e813a0..33ab98dec 100644 --- a/man/ExprList_arg_max.Rd +++ b/man/ExprList_arg_max.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_arg_max} \alias{ExprList_arg_max} -\alias{list_arg_max} \title{Get the index of the maximal value in list} \usage{ ExprList_arg_max() diff --git a/man/ExprList_arg_min.Rd b/man/ExprList_arg_min.Rd index fcfe461fb..6dff5b3b0 100644 --- a/man/ExprList_arg_min.Rd +++ b/man/ExprList_arg_min.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_arg_min} \alias{ExprList_arg_min} -\alias{list_arg_min} \title{Get the index of the minimal value in list} \usage{ ExprList_arg_min() diff --git a/man/ExprList_concat.Rd b/man/ExprList_concat.Rd index a743111cd..e36b09c02 100644 --- a/man/ExprList_concat.Rd +++ b/man/ExprList_concat.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_concat} \alias{ExprList_concat} -\alias{list_concat} \title{Concat two list variables} \usage{ ExprList_concat(other) diff --git a/man/ExprList_contains.Rd b/man/ExprList_contains.Rd index de838ce77..01360c734 100644 --- a/man/ExprList_contains.Rd +++ b/man/ExprList_contains.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_contains} \alias{ExprList_contains} -\alias{list_contains} \title{Check if list contains a given value} \usage{ ExprList_contains(item) diff --git a/man/ExprList_diff.Rd b/man/ExprList_diff.Rd index e76bafea2..2417148cc 100644 --- a/man/ExprList_diff.Rd +++ b/man/ExprList_diff.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_diff} \alias{ExprList_diff} -\alias{list_diff} \title{Compute difference between list values} \usage{ ExprList_diff(n = 1, null_behavior = c("ignore", "drop")) diff --git a/man/ExprList_eval.Rd b/man/ExprList_eval.Rd index 6f04b96d5..3a8c700c4 100644 --- a/man/ExprList_eval.Rd +++ b/man/ExprList_eval.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_eval} \alias{ExprList_eval} -\alias{list_eval} \title{Run any polars expression on the list values} \usage{ ExprList_eval(expr, parallel = FALSE) diff --git a/man/ExprList_first.Rd b/man/ExprList_first.Rd index 8ce1aa20f..1a1713211 100644 --- a/man/ExprList_first.Rd +++ b/man/ExprList_first.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_first} \alias{ExprList_first} -\alias{list_first} \title{Get the first value in a list} \usage{ ExprList_first() diff --git a/man/ExprList_gather.Rd b/man/ExprList_gather.Rd index ae6765620..7ac0ffe48 100644 --- a/man/ExprList_gather.Rd +++ b/man/ExprList_gather.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_gather} \alias{ExprList_gather} -\alias{list_gather} \title{Get several values by index in a list} \usage{ ExprList_gather(index, null_on_oob = FALSE) diff --git a/man/ExprList_head.Rd b/man/ExprList_head.Rd index 9d056fbb0..9353a0e0d 100644 --- a/man/ExprList_head.Rd +++ b/man/ExprList_head.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_head} \alias{ExprList_head} -\alias{list_head} \title{Get the first \code{n} values of a list} \usage{ ExprList_head(n = 5L) diff --git a/man/ExprList_join.Rd b/man/ExprList_join.Rd index 152c0c639..9b59e3bc0 100644 --- a/man/ExprList_join.Rd +++ b/man/ExprList_join.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_join} \alias{ExprList_join} -\alias{list_join} \title{Join elements of a list} \usage{ ExprList_join(separator, ignore_nulls = FALSE) diff --git a/man/ExprList_last.Rd b/man/ExprList_last.Rd index fc8395a22..36172f05b 100644 --- a/man/ExprList_last.Rd +++ b/man/ExprList_last.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_last} \alias{ExprList_last} -\alias{list_last} \title{Get the last value in a list} \usage{ ExprList_last() diff --git a/man/ExprList_len.Rd b/man/ExprList_len.Rd index 4a6b8799f..329bf5a2f 100644 --- a/man/ExprList_len.Rd +++ b/man/ExprList_len.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_len} \alias{ExprList_len} -\alias{list_len} \title{Get the length of each list} \usage{ ExprList_len() diff --git a/man/ExprList_max.Rd b/man/ExprList_max.Rd index f142cb916..5bf3a0cdc 100644 --- a/man/ExprList_max.Rd +++ b/man/ExprList_max.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_max} \alias{ExprList_max} -\alias{list_max} \title{Find the maximum value in a list} \usage{ ExprList_max() diff --git a/man/ExprList_mean.Rd b/man/ExprList_mean.Rd index dee2e0891..c418727dd 100644 --- a/man/ExprList_mean.Rd +++ b/man/ExprList_mean.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_mean} \alias{ExprList_mean} -\alias{list_mean} \title{Compute the mean value of a list} \usage{ ExprList_mean() diff --git a/man/ExprList_min.Rd b/man/ExprList_min.Rd index ec7191989..c5512a54b 100644 --- a/man/ExprList_min.Rd +++ b/man/ExprList_min.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_min} \alias{ExprList_min} -\alias{list_min} \title{Find the minimum value in a list} \usage{ ExprList_min() diff --git a/man/ExprList_n_unique.Rd b/man/ExprList_n_unique.Rd index 08f4b844e..1107ca019 100644 --- a/man/ExprList_n_unique.Rd +++ b/man/ExprList_n_unique.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_n_unique} \alias{ExprList_n_unique} -\alias{list_n_unique} \title{Get the number of unique values in a list} \usage{ ExprList_n_unique() diff --git a/man/ExprList_reverse.Rd b/man/ExprList_reverse.Rd index fff24eeaa..c22b4acea 100644 --- a/man/ExprList_reverse.Rd +++ b/man/ExprList_reverse.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_reverse} \alias{ExprList_reverse} -\alias{list_reverse} \title{Reverse values in a list} \usage{ ExprList_reverse() diff --git a/man/ExprList_shift.Rd b/man/ExprList_shift.Rd index 8494d4b64..67f8bc9cc 100644 --- a/man/ExprList_shift.Rd +++ b/man/ExprList_shift.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_shift} \alias{ExprList_shift} -\alias{list_shift} \title{Shift list values by \code{n} indices} \usage{ ExprList_shift(periods = 1) diff --git a/man/ExprList_slice.Rd b/man/ExprList_slice.Rd index c686a2fb8..d579c7429 100644 --- a/man/ExprList_slice.Rd +++ b/man/ExprList_slice.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_slice} \alias{ExprList_slice} -\alias{list_slice} \title{Slice list} \usage{ ExprList_slice(offset, length = NULL) diff --git a/man/ExprList_sort.Rd b/man/ExprList_sort.Rd index d620d6ac4..bd2620bf2 100644 --- a/man/ExprList_sort.Rd +++ b/man/ExprList_sort.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_sort} \alias{ExprList_sort} -\alias{list_sort} \title{Sort values in a list} \usage{ ExprList_sort(descending = FALSE) diff --git a/man/ExprList_sum.Rd b/man/ExprList_sum.Rd index 63fdd47fc..43228e483 100644 --- a/man/ExprList_sum.Rd +++ b/man/ExprList_sum.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_sum} \alias{ExprList_sum} -\alias{list_sum} \title{Sum all elements in a list} \usage{ ExprList_sum() diff --git a/man/ExprList_tail.Rd b/man/ExprList_tail.Rd index 8f78f96eb..5ec6e7e83 100644 --- a/man/ExprList_tail.Rd +++ b/man/ExprList_tail.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_tail} \alias{ExprList_tail} -\alias{list_tail} \title{Get the last \code{n} values of a list} \usage{ ExprList_tail(n = 5L) diff --git a/man/ExprList_to_struct.Rd b/man/ExprList_to_struct.Rd index a54411f37..1a3aaee94 100644 --- a/man/ExprList_to_struct.Rd +++ b/man/ExprList_to_struct.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_to_struct} \alias{ExprList_to_struct} -\alias{list_to_struct} \title{Convert a Series of type \code{List} to \code{Struct}} \usage{ ExprList_to_struct( diff --git a/man/ExprList_unique.Rd b/man/ExprList_unique.Rd index fb637e02b..7914cd0de 100644 --- a/man/ExprList_unique.Rd +++ b/man/ExprList_unique.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/expr__list.R \name{ExprList_unique} \alias{ExprList_unique} -\alias{list_unique} \title{Get unique values in a list} \usage{ ExprList_unique() diff --git a/man/ExprStr_to_date.Rd b/man/ExprStr_to_date.Rd index a1ba913cf..78e1750a2 100644 --- a/man/ExprStr_to_date.Rd +++ b/man/ExprStr_to_date.Rd @@ -3,12 +3,6 @@ \name{ExprStr_to_date} \alias{ExprStr_to_date} \title{Convert a String column into a Date column} -\format{ -Format to use for conversion. Refer to -\href{https://docs.rs/chrono/latest/chrono/format/strftime/index.html}{the chrono crate documentation} -for the full specification. Example: \code{"\%Y-\%m-\%d"}. -If \code{NULL} (default), the format is inferred from the data. -} \usage{ ExprStr_to_date(format = NULL, ..., strict = TRUE, exact = TRUE, cache = TRUE) } diff --git a/man/ExprStr_to_time.Rd b/man/ExprStr_to_time.Rd index 03d9a0319..6d60be0f7 100644 --- a/man/ExprStr_to_time.Rd +++ b/man/ExprStr_to_time.Rd @@ -3,12 +3,6 @@ \name{ExprStr_to_time} \alias{ExprStr_to_time} \title{Convert a String column into a Time column} -\format{ -Format to use for conversion. Refer to -\href{https://docs.rs/chrono/latest/chrono/format/strftime/index.html}{the chrono crate documentation} -for the full specification. Example: \code{"\%H:\%M:\%S"}. -If \code{NULL} (default), the format is inferred from the data. -} \usage{ ExprStr_to_time(format = NULL, ..., strict = TRUE, cache = TRUE) } diff --git a/man/ExprStruct_field.Rd b/man/ExprStruct_field.Rd index b9006f331..858922978 100644 --- a/man/ExprStruct_field.Rd +++ b/man/ExprStruct_field.Rd @@ -2,20 +2,18 @@ % Please edit documentation in R/expr__struct.R \name{ExprStruct_field} \alias{ExprStruct_field} -\alias{expr_struct_field} -\title{field} +\title{Retrieve one of the fields of this Struct as a new Series} \usage{ ExprStruct_field(name) } \arguments{ -\item{name}{string, the Name of the struct field to retrieve.} +\item{name}{Name of the field.} } \value{ -Expr: Series of same and name selected field. +Expr of datatype Struct } \description{ -Retrieve a \code{Struct} field as a new Series. -By default base 2. +Retrieve one of the fields of this Struct as a new Series } \examples{ df = pl$DataFrame( @@ -32,4 +30,3 @@ df$select( pl$col("struct_col")$struct$field("ddd") ) } -\keyword{ExprStruct} diff --git a/man/ExprStruct_rename_fields.Rd b/man/ExprStruct_rename_fields.Rd index f3d42e940..f1f871ed5 100644 --- a/man/ExprStruct_rename_fields.Rd +++ b/man/ExprStruct_rename_fields.Rd @@ -2,21 +2,20 @@ % Please edit documentation in R/expr__struct.R \name{ExprStruct_rename_fields} \alias{ExprStruct_rename_fields} -\alias{expr_struct_rename_fields} -\title{rename fields} +\title{Rename the fields of the struct} \usage{ ExprStruct_rename_fields(names) } \arguments{ -\item{names}{char vec or list of strings given in the same order as the struct's fields. -Providing fewer names will drop the latter fields. Providing too many names is ignored.} +\item{names}{Vector or list of strings given in the same order as the struct's +fields. Providing fewer names will drop the latter fields. If too many names +are given, the extra names are ignored.} } \value{ -Expr: struct-series with new names for the fields +Expr of datatype Struct } \description{ -Rename the fields of the struct. -By default base 2. +Rename the fields of the struct } \examples{ df = pl$DataFrame( @@ -31,4 +30,3 @@ df = pl$DataFrame( ) df$unnest() } -\keyword{ExprStruct} diff --git a/man/pl_Field_class.Rd b/man/pl_Field_class.Rd index b0dd5132b..41e113570 100644 --- a/man/pl_Field_class.Rd +++ b/man/pl_Field_class.Rd @@ -3,8 +3,6 @@ \name{pl_Field_class} \alias{pl_Field_class} \alias{pl_Field} -\alias{RField_class} -\alias{RPolarsRField} \title{Create Field} \usage{ pl_Field(name, datatype) @@ -15,7 +13,7 @@ pl_Field(name, datatype) \item{datatype}{\link[=pl_dtypes]{DataType}} } \value{ -An \link{RPolarsRField} object containing its name and its +An object of class \code{"RPolarsRField"} containing its name and its \link[=pl_dtypes]{data type}. } \description{