feat: add missing functions and docs for LazyFrame

R/000-wrappers.R

@@ -285,6 +285,11 @@ NULL
   .savvy_wrap_PlRWhen(.Call(savvy_when__impl, `condition`))
 }
 
+
+`deserialize_lf` <- function(`json`) {
+  .savvy_wrap_PlRLazyFrame(.Call(savvy_deserialize_lf__impl, `json`))
+}
+
 ### wrapper functions for PlRChainedThen
 
 `PlRChainedThen_when` <- function(self) {
@@ -3361,6 +3366,271 @@ class(`PlRExpr`) <- c("PlRExpr__bundle", "savvy_neopolars__sealed")
   }
 }
 
+`PlRLazyFrame_to_dot` <- function(self) {
+  function(`optimized`) {
+    .savvy_wrap_String(.Call(savvy_PlRLazyFrame_to_dot__impl, `self`, `optimized`))
+  }
+}
+
+`PlRLazyFrame_sort` <- function(self) {
+  function(`by_column`, `descending`, `nulls_last`, `maintain_order`, `multithreaded`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_sort__impl, `self`, `by_column`, `descending`, `nulls_last`, `maintain_order`, `multithreaded`))
+  }
+}
+
+`PlRLazyFrame_top_k` <- function(self) {
+  function(`k`, `by`, `reverse`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_top_k__impl, `self`, `k`, `by`, `reverse`))
+  }
+}
+
+`PlRLazyFrame_bottom_k` <- function(self) {
+  function(`k`, `by`, `reverse`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_bottom_k__impl, `self`, `k`, `by`, `reverse`))
+  }
+}
+
+`PlRLazyFrame_cache` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_cache__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_profile` <- function(self) {
+  function() {
+    .Call(savvy_PlRLazyFrame_profile__impl, `self`)
+  }
+}
+
+`PlRLazyFrame_sink_parquet` <- function(self) {
+  function(`path`, `compression`, `maintain_order`, `statistics`, `retries`, `compression_level` = NULL, `row_group_size` = NULL, `data_page_size` = NULL, `storage_options` = NULL) {
+    invisible(.Call(savvy_PlRLazyFrame_sink_parquet__impl, `self`, `path`, `compression`, `maintain_order`, `statistics`, `retries`, `compression_level`, `row_group_size`, `data_page_size`, `storage_options`))
+  }
+}
+
+`PlRLazyFrame_sink_ipc` <- function(self) {
+  function(`path`, `maintain_order`, `retries`, `compression` = NULL, `storage_options` = NULL) {
+    invisible(.Call(savvy_PlRLazyFrame_sink_ipc__impl, `self`, `path`, `maintain_order`, `retries`, `compression`, `storage_options`))
+  }
+}
+
+`PlRLazyFrame_sink_csv` <- function(self) {
+  function(`path`, `include_bom`, `include_header`, `separator`, `line_terminator`, `quote_char`, `maintain_order`, `batch_size`, `retries`, `datetime_format` = NULL, `date_format` = NULL, `time_format` = NULL, `float_scientific` = NULL, `float_precision` = NULL, `null_value` = NULL, `quote_style` = NULL, `storage_options` = NULL) {
+    invisible(.Call(savvy_PlRLazyFrame_sink_csv__impl, `self`, `path`, `include_bom`, `include_header`, `separator`, `line_terminator`, `quote_char`, `maintain_order`, `batch_size`, `retries`, `datetime_format`, `date_format`, `time_format`, `float_scientific`, `float_precision`, `null_value`, `quote_style`, `storage_options`))
+  }
+}
+
+`PlRLazyFrame_sink_json` <- function(self) {
+  function(`path`, `maintain_order`, `retries`, `storage_options` = NULL) {
+    invisible(.Call(savvy_PlRLazyFrame_sink_json__impl, `self`, `path`, `maintain_order`, `retries`, `storage_options`))
+  }
+}
+
+`PlRLazyFrame_serialize` <- function(self) {
+  function() {
+    .Call(savvy_PlRLazyFrame_serialize__impl, `self`)
+  }
+}
+
+`PlRLazyFrame_select_seq` <- function(self) {
+  function(`exprs`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_select_seq__impl, `self`, `exprs`))
+  }
+}
+
+`PlRLazyFrame_rolling` <- function(self) {
+  function(`index_column`, `period`, `offset`, `closed`, `by`) {
+    `index_column` <- .savvy_extract_ptr(`index_column`, "PlRExpr")
+    .savvy_wrap_PlRLazyGroupBy(.Call(savvy_PlRLazyFrame_rolling__impl, `self`, `index_column`, `period`, `offset`, `closed`, `by`))
+  }
+}
+
+`PlRLazyFrame_group_by_dynamic` <- function(self) {
+  function(`index_column`, `every`, `period`, `offset`, `label`, `include_boundaries`, `closed`, `group_by`, `start_by`) {
+    `index_column` <- .savvy_extract_ptr(`index_column`, "PlRExpr")
+    .savvy_wrap_PlRLazyGroupBy(.Call(savvy_PlRLazyFrame_group_by_dynamic__impl, `self`, `index_column`, `every`, `period`, `offset`, `label`, `include_boundaries`, `closed`, `group_by`, `start_by`))
+  }
+}
+
+`PlRLazyFrame_with_context` <- function(self) {
+  function(`contexts`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_with_context__impl, `self`, `contexts`))
+  }
+}
+
+`PlRLazyFrame_join_asof` <- function(self) {
+  function(`other`, `left_on`, `right_on`, `allow_parallel`, `force_parallel`, `suffix`, `coalesce`, `strategy`, `left_by` = NULL, `right_by` = NULL, `tolerance` = NULL, `tolerance_str` = NULL) {
+    `other` <- .savvy_extract_ptr(`other`, "PlRLazyFrame")
+    `left_on` <- .savvy_extract_ptr(`left_on`, "PlRExpr")
+    `right_on` <- .savvy_extract_ptr(`right_on`, "PlRExpr")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_join_asof__impl, `self`, `other`, `left_on`, `right_on`, `allow_parallel`, `force_parallel`, `suffix`, `coalesce`, `strategy`, `left_by`, `right_by`, `tolerance`, `tolerance_str`))
+  }
+}
+
+`PlRLazyFrame_join` <- function(self) {
+  function(`other`, `left_on`, `right_on`, `allow_parallel`, `force_parallel`, `join_nulls`, `how`, `suffix`, `validate`, `coalesce` = NULL) {
+    `other` <- .savvy_extract_ptr(`other`, "PlRLazyFrame")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_join__impl, `self`, `other`, `left_on`, `right_on`, `allow_parallel`, `force_parallel`, `join_nulls`, `how`, `suffix`, `validate`, `coalesce`))
+  }
+}
+
+`PlRLazyFrame_join_where` <- function(self) {
+  function(`other`, `predicates`, `suffix`) {
+    `other` <- .savvy_extract_ptr(`other`, "PlRLazyFrame")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_join_where__impl, `self`, `other`, `predicates`, `suffix`))
+  }
+}
+
+`PlRLazyFrame_with_columns_seq` <- function(self) {
+  function(`exprs`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_with_columns_seq__impl, `self`, `exprs`))
+  }
+}
+
+`PlRLazyFrame_rename` <- function(self) {
+  function(`existing`, `new`, `strict`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_rename__impl, `self`, `existing`, `new`, `strict`))
+  }
+}
+
+`PlRLazyFrame_reverse` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_reverse__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_shift` <- function(self) {
+  function(`n`, `fill_value` = NULL) {
+    `n` <- .savvy_extract_ptr(`n`, "PlRExpr")
+    `fill_value` <- .savvy_extract_ptr(`fill_value`, "PlRExpr")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_shift__impl, `self`, `n`, `fill_value`))
+  }
+}
+
+`PlRLazyFrame_fill_nan` <- function(self) {
+  function(`fill_value`) {
+    `fill_value` <- .savvy_extract_ptr(`fill_value`, "PlRExpr")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_fill_nan__impl, `self`, `fill_value`))
+  }
+}
+
+`PlRLazyFrame_fill_null` <- function(self) {
+  function(`fill_value`) {
+    `fill_value` <- .savvy_extract_ptr(`fill_value`, "PlRExpr")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_fill_null__impl, `self`, `fill_value`))
+  }
+}
+
+`PlRLazyFrame_min` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_min__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_max` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_max__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_sum` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_sum__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_mean` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_mean__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_std` <- function(self) {
+  function(`ddof`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_std__impl, `self`, `ddof`))
+  }
+}
+
+`PlRLazyFrame_var` <- function(self) {
+  function(`ddof`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_var__impl, `self`, `ddof`))
+  }
+}
+
+`PlRLazyFrame_median` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_median__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_quantile` <- function(self) {
+  function(`quantile`, `interpolation`) {
+    `quantile` <- .savvy_extract_ptr(`quantile`, "PlRExpr")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_quantile__impl, `self`, `quantile`, `interpolation`))
+  }
+}
+
+`PlRLazyFrame_explode` <- function(self) {
+  function(`column`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_explode__impl, `self`, `column`))
+  }
+}
+
+`PlRLazyFrame_null_count` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_null_count__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_unique` <- function(self) {
+  function(`maintain_order`, `keep`, `subset` = NULL) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_unique__impl, `self`, `maintain_order`, `keep`, `subset`))
+  }
+}
+
+`PlRLazyFrame_drop_nulls` <- function(self) {
+  function(`subset` = NULL) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_drop_nulls__impl, `self`, `subset`))
+  }
+}
+
+`PlRLazyFrame_unpivot` <- function(self) {
+  function(`on`, `index`, `value_name` = NULL, `variable_name` = NULL) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_unpivot__impl, `self`, `on`, `index`, `value_name`, `variable_name`))
+  }
+}
+
+`PlRLazyFrame_with_row_index` <- function(self) {
+  function(`name`, `offset` = NULL) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_with_row_index__impl, `self`, `name`, `offset`))
+  }
+}
+
+`PlRLazyFrame_clone` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_clone__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_unnest` <- function(self) {
+  function(`columns`) {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_unnest__impl, `self`, `columns`))
+  }
+}
+
+`PlRLazyFrame_count` <- function(self) {
+  function() {
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_count__impl, `self`))
+  }
+}
+
+`PlRLazyFrame_merge_sorted` <- function(self) {
+  function(`other`, `key`) {
+    `other` <- .savvy_extract_ptr(`other`, "PlRLazyFrame")
+    .savvy_wrap_PlRLazyFrame(.Call(savvy_PlRLazyFrame_merge_sorted__impl, `self`, `other`, `key`))
+  }
+}
+
 `.savvy_wrap_PlRLazyFrame` <- function(ptr) {
   e <- new.env(parent = emptyenv())
   e$.ptr <- ptr
@@ -3381,6 +3651,48 @@ class(`PlRExpr`) <- c("PlRExpr__bundle", "savvy_neopolars__sealed")
   e$`collect_schema` <- `PlRLazyFrame_collect_schema`(ptr)
   e$`sort_by_exprs` <- `PlRLazyFrame_sort_by_exprs`(ptr)
   e$`with_columns` <- `PlRLazyFrame_with_columns`(ptr)
+  e$`to_dot` <- `PlRLazyFrame_to_dot`(ptr)
+  e$`sort` <- `PlRLazyFrame_sort`(ptr)
+  e$`top_k` <- `PlRLazyFrame_top_k`(ptr)
+  e$`bottom_k` <- `PlRLazyFrame_bottom_k`(ptr)
+  e$`cache` <- `PlRLazyFrame_cache`(ptr)
+  e$`profile` <- `PlRLazyFrame_profile`(ptr)
+  e$`sink_parquet` <- `PlRLazyFrame_sink_parquet`(ptr)
+  e$`sink_ipc` <- `PlRLazyFrame_sink_ipc`(ptr)
+  e$`sink_csv` <- `PlRLazyFrame_sink_csv`(ptr)
+  e$`sink_json` <- `PlRLazyFrame_sink_json`(ptr)
+  e$`serialize` <- `PlRLazyFrame_serialize`(ptr)
+  e$`select_seq` <- `PlRLazyFrame_select_seq`(ptr)
+  e$`rolling` <- `PlRLazyFrame_rolling`(ptr)
+  e$`group_by_dynamic` <- `PlRLazyFrame_group_by_dynamic`(ptr)
+  e$`with_context` <- `PlRLazyFrame_with_context`(ptr)
+  e$`join_asof` <- `PlRLazyFrame_join_asof`(ptr)
+  e$`join` <- `PlRLazyFrame_join`(ptr)
+  e$`join_where` <- `PlRLazyFrame_join_where`(ptr)
+  e$`with_columns_seq` <- `PlRLazyFrame_with_columns_seq`(ptr)
+  e$`rename` <- `PlRLazyFrame_rename`(ptr)
+  e$`reverse` <- `PlRLazyFrame_reverse`(ptr)
+  e$`shift` <- `PlRLazyFrame_shift`(ptr)
+  e$`fill_nan` <- `PlRLazyFrame_fill_nan`(ptr)
+  e$`fill_null` <- `PlRLazyFrame_fill_null`(ptr)
+  e$`min` <- `PlRLazyFrame_min`(ptr)
+  e$`max` <- `PlRLazyFrame_max`(ptr)
+  e$`sum` <- `PlRLazyFrame_sum`(ptr)
+  e$`mean` <- `PlRLazyFrame_mean`(ptr)
+  e$`std` <- `PlRLazyFrame_std`(ptr)
+  e$`var` <- `PlRLazyFrame_var`(ptr)
+  e$`median` <- `PlRLazyFrame_median`(ptr)
+  e$`quantile` <- `PlRLazyFrame_quantile`(ptr)
+  e$`explode` <- `PlRLazyFrame_explode`(ptr)
+  e$`null_count` <- `PlRLazyFrame_null_count`(ptr)
+  e$`unique` <- `PlRLazyFrame_unique`(ptr)
+  e$`drop_nulls` <- `PlRLazyFrame_drop_nulls`(ptr)
+  e$`unpivot` <- `PlRLazyFrame_unpivot`(ptr)
+  e$`with_row_index` <- `PlRLazyFrame_with_row_index`(ptr)
+  e$`clone` <- `PlRLazyFrame_clone`(ptr)
+  e$`unnest` <- `PlRLazyFrame_unnest`(ptr)
+  e$`count` <- `PlRLazyFrame_count`(ptr)
+  e$`merge_sorted` <- `PlRLazyFrame_merge_sorted`(ptr)
 
   class(e) <- c("PlRLazyFrame", "savvy_neopolars__sealed")
   e