Merge pull request #118 from yutannihilation/doc/write-parquet

List supported data encodings properly
r-lib · Feb 10, 2025 · f4923a7 · f4923a7
2 parents 47b0fd6 + 08e8fe7
commit f4923a7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/R/write-parquet.R b/R/write-parquet.R
@@ -37,8 +37,11 @@
 #'   or nanoparquet does not implement it, `write_parquet()` throws an
 #'   error.
 #'
-#'   This version of nanoparquet supports the following encodings:
-#'   `r paste("\u0060", names(nanoparquet:::encodings), "\u0060", collapse = ", ")`.
+#'   Currently `write_parquet()` supports the following encodings:
+#'
+#'   - `PLAIN` for all column types,
+#'   - `PLAIN_DICTIONARY` and `RLE_DICTIONARY` for all column types,
+#'   - `RLE` for BOOLEAN columns.
 #'
 #'   See [parquet-encodings] for more about encodings.
 #' @param metadata Additional key-value metadata to add to the file.

diff --git a/man/write_parquet.Rd b/man/write_parquet.Rd