docs: Use stingy instead of frugal (#594)

* docs: Use stingy instead of frugal

* Catch

* Define

Author: krlmlr

R/compute-rd.R

@@ -16,7 +16,7 @@
 #'   intermediate results in DuckDB-managed memory to data frames in R memory.
 #'
 #'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never,
+#'   - `"stingy"`: never,
 #'   - `"thrifty"`: up to a maximum size of 1 million cells.
 #'
 #' The default is to inherit from the input.

R/duckplyr_df.R

@@ -74,13 +74,22 @@ prudence_parse <- function(prudence, call = caller_env()) {
       }
     }
     allow_materialization <- is.finite(n_rows) || is.finite(n_cells)
-    prudence <- "frugal"
+    prudence <- "stingy"
   } else if (!is.character(prudence)) {
     cli::cli_abort("{.arg prudence} must be an unnamed character vector or a named numeric vector", call = call)
   } else {
-    prudence <- arg_match(prudence, c("lavish", "frugal", "thrifty"), error_call = call)
+    if (identical(prudence, "frugal")) {
+      lifecycle::deprecate_warn("1.0.0",
+        I('Use `prudence = "stingy"` instead, `prudence = "frugal"`'),
+        always = TRUE,
+        env = call
+      )
+      prudence <- "stingy"
+    }
+    # Can't change second argument to arg_match() here
+    prudence <- arg_match(prudence, c("lavish", "stingy", "thrifty"), error_call = call)
 
-    allow_materialization <- !identical(prudence, "frugal")
+    allow_materialization <- !identical(prudence, "stingy")
     if (!allow_materialization) {
       n_cells <- 0
     } else if (identical(prudence, "thrifty")) {
@@ -104,7 +113,7 @@ get_prudence_duckplyr_df <- function(x) {
 
   prudence <- attr(x, "prudence")
   if (is.null(prudence)) {
-    return("frugal")
+    return("stingy")
   }
 
   if (identical(prudence, c(cells = 1e6))) {

R/ducktbl.R

@@ -15,7 +15,7 @@
 #'   intermediate results in DuckDB-managed memory to data frames in R memory.
 #'
 #'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never,
+#'   - `"stingy"`: never,
 #'   - `"thrifty"`: up to a maximum size of 1 million cells.
 #'
 #' The default is `"lavish"` for `duckdb_tibble()` and `as_duckdb_tibble()`,
@@ -47,12 +47,12 @@
 #'
 #' x$a
 #'
-#' y <- duckdb_tibble(a = 1, .prudence = "frugal")
+#' y <- duckdb_tibble(a = 1, .prudence = "stingy")
 #' y
 #' try(length(y$a))
 #' length(collect(y)$a)
 #' @export
-duckdb_tibble <- function(..., .prudence = c("lavish", "thrifty", "frugal")) {
+duckdb_tibble <- function(..., .prudence = c("lavish", "thrifty", "stingy")) {
   out <- tibble::tibble(...)
 
   # Side effect: check compatibility
@@ -72,7 +72,7 @@ duckdb_tibble <- function(..., .prudence = c("lavish", "thrifty", "frugal")) {
 #' @param x The object to convert or to test.
 #' @rdname duckdb_tibble
 #' @export
-as_duckdb_tibble <- function(x, ..., prudence = c("lavish", "thrifty", "frugal")) {
+as_duckdb_tibble <- function(x, ..., prudence = c("lavish", "thrifty", "stingy")) {
   # Handle the prudence arg in the generic, only the other args will be dispatched
   as_duckdb_tibble <- function(x, ...) {
     UseMethod("as_duckdb_tibble")
@@ -90,7 +90,7 @@ as_duckdb_tibble.tbl_duckdb_connection <- function(x, ...) {
   sql <- dbplyr::remote_query(x)
 
   # Start restrictive to avoid accidental materialization
-  read_sql_duckdb(sql, prudence = "frugal", con = con)
+  read_sql_duckdb(sql, prudence = "stingy", con = con)
 }
 
 #' @export

R/io2.R

@@ -13,7 +13,7 @@ NULL
 #'
 #' @rdname read_file_duckdb
 #' @export
-read_parquet_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "frugal"), options = list()) {
+read_parquet_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "stingy"), options = list()) {
   check_dots_empty()
 
   read_file_duckdb(path, "read_parquet", prudence = prudence, options = options)
@@ -50,7 +50,7 @@ read_parquet_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "fr
 #'   path,
 #'   options = list(delim = ",", types = list(c("DOUBLE", "VARCHAR")))
 #' )
-read_csv_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "frugal"), options = list()) {
+read_csv_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "stingy"), options = list()) {
   check_dots_empty()
 
   read_file_duckdb(path, "read_csv_auto", prudence = prudence, options = options)
@@ -71,7 +71,7 @@ read_csv_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "frugal
 #' db_exec("INSTALL json")
 #' db_exec("LOAD json")
 #' read_json_duckdb(path)
-read_json_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "frugal"), options = list()) {
+read_json_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "stingy"), options = list()) {
   check_dots_empty()
 
   read_file_duckdb(path, "read_json", prudence = prudence, options = options)
@@ -95,7 +95,7 @@ read_json_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "fruga
 #'
 #'   - `"thrifty"`: up to a maximum size of 1 million cells,
 #'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never.
+#'   - `"stingy"`: never.
 #'
 #' The default is `"thrifty"` for the ingestion functions,
 #' and may be different for other functions.
@@ -114,7 +114,7 @@ read_file_duckdb <- function(
   path,
   table_function,
   ...,
-  prudence = c("thrifty", "lavish", "frugal"),
+  prudence = c("thrifty", "lavish", "stingy"),
   options = list()
 ) {
   check_dots_empty()

R/mutate.R

@@ -23,7 +23,7 @@ mutate.duckplyr_df <- function(.data, ..., .by = NULL, .keep = c("all", "used",
 
       names_used <- character()
       names_new <- character()
-      current_data <- rel_to_df(rel, prudence = "frugal")
+      current_data <- rel_to_df(rel, prudence = "stingy")
 
       # FIXME: use fewer projections
       for (i in seq_along(dots)) {
@@ -71,7 +71,7 @@ mutate.duckplyr_df <- function(.data, ..., .by = NULL, .keep = c("all", "used",
         }
 
         rel <- rel_project(rel, unname(exprs))
-        current_data <- rel_to_df(rel, prudence = "frugal")
+        current_data <- rel_to_df(rel, prudence = "stingy")
       }
 
       if (length(by_names) > 0) {

R/relational.R

@@ -141,7 +141,7 @@ check_prudence <- function(x, duckplyr_error, call = caller_env()) {
     duckplyr_error_msg <- if (is.character(duckplyr_error)) duckplyr_error
     duckplyr_error_parent <- if (is_condition(duckplyr_error)) duckplyr_error
     cli::cli_abort(parent = duckplyr_error_parent, call = call, c(
-      "This operation cannot be carried out by DuckDB, and the input is a frugal duckplyr frame.",
+      "This operation cannot be carried out by DuckDB, and the input is a stingy duckplyr frame.",
       "*" = duckplyr_error_msg,
       "i" = 'Use {.code compute(prudence = "lavish")} to materialize to temporary storage and continue with {.pkg duckplyr}.',
       "i" = 'See {.run vignette("prudence")} for other options.'

R/sql.R

@@ -18,7 +18,7 @@
 #' @export
 #' @examples
 #' read_sql_duckdb("FROM duckdb_settings()")
-read_sql_duckdb <- function(sql, ..., prudence = c("thrifty", "lavish", "frugal"), con = NULL) {
+read_sql_duckdb <- function(sql, ..., prudence = c("thrifty", "lavish", "stingy"), con = NULL) {
   if (!is_string(sql)) {
     cli::cli_abort("{.arg sql} must be a string.")
   }

man/compute.duckplyr_df.Rd

@@ -29,7 +29,7 @@ diff --git b/R/mutate.R a/R/mutate.R
 +
 +      names_used <- character()
 +      names_new <- character()
-+      current_data <- rel_to_df(rel, prudence = "frugal")
++      current_data <- rel_to_df(rel, prudence = "stingy")
 +
 +      # FIXME: use fewer projections
 +      for (i in seq_along(dots)) {
@@ -77,7 +77,7 @@ diff --git b/R/mutate.R a/R/mutate.R
 +        }
 +
 +        rel <- rel_project(rel, unname(exprs))
-+        current_data <- rel_to_df(rel, prudence = "frugal")
++        current_data <- rel_to_df(rel, prudence = "stingy")
 +      }
 +
 +      if (length(by_names) > 0) {

man/compute_file.Rd

@@ -1,10 +1,10 @@
 # desc() fails if it points elsewhere
 
     Code
-      duckdb_tibble(a = 1:3, .prudence = "frugal") %>% arrange(desc(a))
+      duckdb_tibble(a = 1:3, .prudence = "stingy") %>% arrange(desc(a))
     Condition
       Error in `arrange()`:
-      ! This operation cannot be carried out by DuckDB, and the input is a frugal duckplyr frame.
+      ! This operation cannot be carried out by DuckDB, and the input is a stingy duckplyr frame.
       i Use `compute(prudence = "lavish")` to materialize to temporary storage and continue with duckplyr.
       i See `vignette("prudence")` for other options.
       Caused by error in `arrange()`:
@@ -13,10 +13,10 @@
 # desc() fails for more than one argument
 
     Code
-      duckdb_tibble(a = 1:3, b = 4:6, .prudence = "frugal") %>% arrange(desc(a, b))
+      duckdb_tibble(a = 1:3, b = 4:6, .prudence = "stingy") %>% arrange(desc(a, b))
     Condition
       Error in `arrange()`:
-      ! This operation cannot be carried out by DuckDB, and the input is a frugal duckplyr frame.
+      ! This operation cannot be carried out by DuckDB, and the input is a stingy duckplyr frame.
       i Use `compute(prudence = "lavish")` to materialize to temporary storage and continue with duckplyr.
       i See `vignette("prudence")` for other options.
       Caused by error in `arrange()`:

man/duckdb_tibble.Rd

@@ -29,7 +29,7 @@ test_that("compute_csv()", {
 test_that("compute_csv() prudence", {
   df <- data.frame(x = c(1, 2))
   withr::defer(unlink("test.csv"))
-  out <- compute_csv(df, path = "test.csv", prudence = "frugal")
+  out <- compute_csv(df, path = "test.csv", prudence = "stingy")
 
   expect_true(is_prudent_duckplyr_df(out))
   expect_identical(collect(out), as_tibble(df))

man/read_file_duckdb.Rd

@@ -7,8 +7,8 @@ test_that("Can construct", {
   expect_identical(duckdb_tibble(a = 1)$a, 1)
 })
 
-test_that('.prudence = "frugal" forbids materialization', {
-  tbl <- duckdb_tibble(a = 1, .prudence = "frugal")
+test_that('.prudence = "stingy" forbids materialization', {
+  tbl <- duckdb_tibble(a = 1, .prudence = "stingy")
   expect_error(length(tbl$a))
 })
 
@@ -22,8 +22,8 @@ test_that('.prudence = c(cells = ) forbids materialization', {
   expect_error(length(tbl$a))
 })
 
-test_that('.prudence = "frugal" forbids materialization for as_duckdb_tibble', {
-  tbl <- as_duckdb_tibble(data.frame(a = 1), prudence = "frugal")
+test_that('.prudence = "stingy" forbids materialization for as_duckdb_tibble', {
+  tbl <- as_duckdb_tibble(data.frame(a = 1), prudence = "stingy")
   expect_error(length(tbl$a))
 })
 
@@ -64,14 +64,14 @@ test_that("as_duckdb_tibble() and dbplyr tables", {
     dplyr::copy_to(dest = con)
 
   duck <- db_tbl %>%
-    as_duckdb_tibble(prudence = "frugal") %>%
+    as_duckdb_tibble(prudence = "stingy") %>%
     mutate(b = 2)
 
   expect_error(length(duck$b))
 
   db <- db_tbl %>%
     mutate(b = 2) %>%
-    as_duckdb_tibble(prudence = "frugal")
+    as_duckdb_tibble(prudence = "stingy")
 
   expect_error(length(db$b))