Skip to content

Commit

Permalink
Split RecordBatch into separate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thisisnic committed Jun 29, 2023
1 parent 6bd2b18 commit 8adcde9
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 27 deletions.
6 changes: 4 additions & 2 deletions r/R/record-batch.R
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
#' Modify or replace by assigning in (`batch$metadata <- new_metadata`).
#' All list elements are coerced to string. See `schema()` for more information.
#' - `$columns`: Returns a list of `Array`s
#' @rdname RecordBatch
#' @rdname RecordBatch-class
#' @name RecordBatch
#' @export
RecordBatch <- R6Class("RecordBatch",
Expand Down Expand Up @@ -169,13 +169,15 @@ RecordBatch$from_message <- function(obj, schema) {
#' @include arrowExports.R
RecordBatch$import_from_c <- ImportRecordBatch

#' Create a RecordBatch
#'
#' @param ... A `data.frame` or a named set of Arrays or vectors. If given a
#' mixture of data.frames and vectors, the inputs will be autospliced together
#' (see examples). Alternatively, you can provide a single Arrow IPC
#' `InputStream`, `Message`, `Buffer`, or R `raw` object containing a `Buffer`.
#' @param schema a [Schema], or `NULL` (the default) to infer the schema from
#' the data in `...`. When providing an Arrow IPC buffer, `schema` is required.
#' @rdname RecordBatch
#' @rdname record_batch
#' @examples
#' batch <- record_batch(name = rownames(mtcars), mtcars)
#' dim(batch)
Expand Down
3 changes: 2 additions & 1 deletion r/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ reference:
- scalar
- arrow_array
- chunked_array
- RecordBatch
- record_batch
- Table
- buffer
- vctrs_extension_array
Expand Down Expand Up @@ -296,6 +296,7 @@ reference:
- Scalar
- Array
- ChunkedArray
- RecordBatch
- Schema
- DataType
- ArrayData
Expand Down
22 changes: 0 additions & 22 deletions r/man/RecordBatch.Rd → r/man/RecordBatch-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions r/man/read_schema.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions r/man/record_batch.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8adcde9

Please sign in to comment.