Skip to content

Commit 84d4d57

Browse files
committed
docs: returns of examples with the gzip method but with a dontrun statement
1 parent 16f56a0 commit 84d4d57

File tree

4 files changed

+32
-1
lines changed

4 files changed

+32
-1
lines changed

R/csv_to_parquet.R

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,18 @@
6464
#' filename_in_zip = "census2021-ts007-ctry.csv",
6565
#' path_to_parquet = tempfile(fileext = ".parquet")
6666
#' )
67-
67+
#'
68+
#' \dontrun{
69+
#' # Conversion from a URL and a csv file with "gzip" compression :
70+
#'
71+
#' csv_to_parquet(
72+
#' path_to_file =
73+
#' "https://github.com/sidsriv/Introduction-to-Data-Science-in-python/raw/master/census.csv",
74+
#' path_to_parquet = tempfile(fileext = ".parquet"),
75+
#' compression = "gzip",
76+
#' compression_level = 5
77+
#' )
78+
#' }
6879
csv_to_parquet <- function(
6980
path_to_file,
7081
url_to_csv = lifecycle::deprecated(),

R/write_parquet_at_once.R

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
#' write_parquet_at_once(iris, tempfile())
1919
#'
2020
#' write_parquet_at_once(iris, tempfile(), partition = "yes", partitioning = c("Species"))
21+
#'
22+
#' \dontrun{
23+
#' write_parquet_at_once(iris, tempfile(), compression="gzip", compression_level = 5)
24+
#' }
2125
write_parquet_at_once <- function(
2226
data,
2327
path_to_parquet,

man/csv_to_parquet.Rd

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/write_parquet_at_once.Rd

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)