diff --git a/NEWS.md b/NEWS.md index ea9e6be7f..b94195288 100644 --- a/NEWS.md +++ b/NEWS.md @@ -7,8 +7,8 @@ - rust-polars is updated to 0.38.3 (#937). - New argument `non_existent` in `$replace_time_zone()` to specify what should happen when a datetime doesn't exist. - - In rolling aggregation functions (such as `$rolling_mean()`), the default - value of argument `closed` now is `NULL`. Using `closed` with a fixed + - In rolling aggregation functions (such as `$rolling_mean()`), the default + value of argument `closed` now is `NULL`. Using `closed` with a fixed `window_size` now throws an error. ### Other breaking changes @@ -18,7 +18,8 @@ - Unify names of input/output function arguments (935). - All arguments except the first argument must be named arguments. - In `pl$read_*` and `pl$scan_*` functions, the first argument is now `source`. - - In `$write_*` and `$sink_*` functions, the first argument is now `file`. + - In `$write_*` functions, the first argument is now `file`. + - In `$sink_*` functions, the first argument is now `path`. - The argument `columns` in `$drop()` is removed. `$drop()` now accepts several character scalars, such as `$drop("a", "b", "c")` (#912). - In `pl$col()`, the `name` argument is removed, and the `...` argument no longer @@ -33,7 +34,7 @@ - New function `is_polars_dtype()` (#927). - New method `to_dot()` to print the query plan of a LazyFrame with graphviz dot syntax (#928). -- Argument `ambiguous` can now take the value `"null"` to convert ambigous +- Argument `ambiguous` can now take the value `"null"` to convert ambigous datetimes to null values (#937). ## Polars R Package 0.15.1 diff --git a/R/lazyframe__lazy.R b/R/lazyframe__lazy.R index b7a4d9dbd..f9f0e33b8 100644 --- a/R/lazyframe__lazy.R +++ b/R/lazyframe__lazy.R @@ -530,7 +530,7 @@ LazyFrame_collect_in_background = function() { #' This writes the output of a query directly to a Parquet file without collecting #' it in the R session first. This is useful if the output of the query is still #' larger than RAM as it would crash the R session if it was collected into R. -#' @param file A character. File path to which the file should be written. +#' @param path A character. File path to which the file should be written. #' @param ... Ignored. #' @param compression String. The compression method. One of: #' * "lz4": fast compression/decompression. @@ -574,7 +574,7 @@ LazyFrame_collect_in_background = function() { #' # load parquet directly into a DataFrame / memory #' pl$scan_parquet(tmpf2)$collect() LazyFrame_sink_parquet = function( - file, + path, ..., compression = "zstd", compression_level = 3, @@ -612,7 +612,7 @@ LazyFrame_sink_parquet = function( lf |> .pr$LazyFrame$sink_parquet( - file, + path, compression, compression_level, statistics, @@ -652,7 +652,7 @@ LazyFrame_sink_parquet = function( #' # load ipc directly into a DataFrame / memory #' # pl$scan_ipc(tmpf2)$collect() LazyFrame_sink_ipc = function( - file, + path, ..., compression = "zstd", maintain_order = TRUE, @@ -686,7 +686,7 @@ LazyFrame_sink_ipc = function( lf |> .pr$LazyFrame$sink_ipc( - file, + path, compression, maintain_order ) |> @@ -721,7 +721,7 @@ LazyFrame_sink_ipc = function( #' # load parquet directly into a DataFrame / memory #' pl$scan_csv(tmpf2)$collect() LazyFrame_sink_csv = function( - file, + path, ..., include_bom = FALSE, include_header = TRUE, @@ -766,7 +766,7 @@ LazyFrame_sink_csv = function( lf |> .pr$LazyFrame$sink_csv( - file, + path, include_bom, include_header, separator, @@ -808,7 +808,7 @@ LazyFrame_sink_csv = function( #' # load parquet directly into a DataFrame / memory #' pl$scan_ndjson(tmpf)$collect() LazyFrame_sink_ndjson = function( - file, + path, ..., maintain_order = TRUE, type_coercion = TRUE, @@ -841,7 +841,7 @@ LazyFrame_sink_ndjson = function( lf |> .pr$LazyFrame$sink_json( - file, + path, maintain_order ) |> unwrap("in $sink_ndjson()") |> diff --git a/man/IO_sink_csv.Rd b/man/IO_sink_csv.Rd index d40028920..ed3162943 100644 --- a/man/IO_sink_csv.Rd +++ b/man/IO_sink_csv.Rd @@ -5,7 +5,7 @@ \title{Stream the output of a query to a CSV file} \usage{ LazyFrame_sink_csv( - file, + path, ..., include_bom = FALSE, include_header = TRUE, @@ -30,7 +30,7 @@ LazyFrame_sink_csv( ) } \arguments{ -\item{file}{File path to which the result should be written.} +\item{path}{A character. File path to which the file should be written.} \item{...}{Ignored.} diff --git a/man/IO_sink_ipc.Rd b/man/IO_sink_ipc.Rd index da564daf1..2fd6bea6a 100644 --- a/man/IO_sink_ipc.Rd +++ b/man/IO_sink_ipc.Rd @@ -5,7 +5,7 @@ \title{Stream the output of a query to an Arrow IPC file} \usage{ LazyFrame_sink_ipc( - file, + path, ..., compression = "zstd", maintain_order = TRUE, @@ -19,7 +19,7 @@ LazyFrame_sink_ipc( ) } \arguments{ -\item{file}{A character. File path to which the file should be written.} +\item{path}{A character. File path to which the file should be written.} \item{...}{Ignored.} diff --git a/man/IO_sink_ndjson.Rd b/man/IO_sink_ndjson.Rd index 794c3bf5a..33ab16293 100644 --- a/man/IO_sink_ndjson.Rd +++ b/man/IO_sink_ndjson.Rd @@ -5,7 +5,7 @@ \title{Stream the output of a query to a JSON file} \usage{ LazyFrame_sink_ndjson( - file, + path, ..., maintain_order = TRUE, type_coercion = TRUE, @@ -18,7 +18,7 @@ LazyFrame_sink_ndjson( ) } \arguments{ -\item{file}{File path to which the result should be written.} +\item{path}{A character. File path to which the file should be written.} \item{...}{Ignored.} diff --git a/man/IO_sink_parquet.Rd b/man/IO_sink_parquet.Rd index 3445da70b..ef2d7550a 100644 --- a/man/IO_sink_parquet.Rd +++ b/man/IO_sink_parquet.Rd @@ -5,7 +5,7 @@ \title{Stream the output of a query to a Parquet file} \usage{ LazyFrame_sink_parquet( - file, + path, ..., compression = "zstd", compression_level = 3, @@ -23,7 +23,7 @@ LazyFrame_sink_parquet( ) } \arguments{ -\item{file}{A character. File path to which the file should be written.} +\item{path}{A character. File path to which the file should be written.} \item{...}{Ignored.} diff --git a/man/IO_write_parquet.Rd b/man/IO_write_parquet.Rd index beee86699..be497c5b8 100644 --- a/man/IO_write_parquet.Rd +++ b/man/IO_write_parquet.Rd @@ -15,7 +15,7 @@ DataFrame_write_parquet( ) } \arguments{ -\item{file}{A character. File path to which the file should be written.} +\item{file}{File path to which the result should be written.} \item{...}{Ignored.}