assignUser commented on code in PR #733:
URL: https://github.com/apache/arrow-nanoarrow/pull/733#discussion_r2019978734
##########
r/R/ipc.R:
##########
@@ -145,9 +145,20 @@ write_nanoarrow.character <- function(data, x, ...) {
write_nanoarrow(data, con)
}
-#' @rdname read_nanoarrow
+#' Example Arrow IPC Data
+#'
+#' An example stream that can be used for testing or examples.
+#'
+#' @param compression One of "none" or "zstd"
+#'
+#' @return A raw vector that can be passed to [read_nanoarrow()]
#' @export
-example_ipc_stream <- function() {
+#'
+#' @examples
+#' as.data.frame(read_nanoarrow(example_ipc_stream()))
+example_ipc_stream <- function(compression = c("none", "zstd")) {
Review Comment:
This is a nice choice, exporting it, instead of hiding it in a test helper!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
