docs: returns of examples with the gzip method but with a dontrun sta…

…tement
ddotta · May 10, 2023 · 84d4d57 · 84d4d57
1 parent 16f56a0
commit 84d4d57
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 1 deletion.
diff --git a/R/csv_to_parquet.R b/R/csv_to_parquet.R
@@ -64,7 +64,18 @@
 #'   filename_in_zip = "census2021-ts007-ctry.csv",
 #'   path_to_parquet = tempfile(fileext = ".parquet")
 #' )
-
+#'
+#' \dontrun{
+#' # Conversion from a URL and a csv file with "gzip" compression :
+#'
+#' csv_to_parquet(
+#'   path_to_file =
+#'   "https://github.com/sidsriv/Introduction-to-Data-Science-in-python/raw/master/census.csv",
+#'   path_to_parquet = tempfile(fileext = ".parquet"),
+#'   compression = "gzip",
+#'   compression_level = 5
+#' )
+#' }
 csv_to_parquet <- function(
     path_to_file,
     url_to_csv = lifecycle::deprecated(),

diff --git a/R/write_parquet_at_once.R b/R/write_parquet_at_once.R
@@ -18,6 +18,10 @@
 #' write_parquet_at_once(iris, tempfile())
 #'
 #' write_parquet_at_once(iris, tempfile(), partition = "yes", partitioning = c("Species"))
+#'
+#' \dontrun{
+#' write_parquet_at_once(iris, tempfile(), compression="gzip", compression_level = 5)
+#' }
 write_parquet_at_once <- function(
     data,
     path_to_parquet,

diff --git a/man/csv_to_parquet.Rd b/man/csv_to_parquet.Rd
diff --git a/man/write_parquet_at_once.Rd b/man/write_parquet_at_once.Rd