File: as_arrow_array.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (39 lines) | stat: -rw-r--r-- 1,161 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/array.R
\name{as_arrow_array}
\alias{as_arrow_array}
\alias{as_arrow_array.Array}
\alias{as_arrow_array.Scalar}
\alias{as_arrow_array.ChunkedArray}
\title{Convert an object to an Arrow Array}
\usage{
as_arrow_array(x, ..., type = NULL)

\method{as_arrow_array}{Array}(x, ..., type = NULL)

\method{as_arrow_array}{Scalar}(x, ..., type = NULL)

\method{as_arrow_array}{ChunkedArray}(x, ..., type = NULL)
}
\arguments{
\item{x}{An object to convert to an Arrow Array}

\item{...}{Passed to S3 methods}

\item{type}{A \link[=data-type]{type} for the final Array. A value of \code{NULL}
will default to the type guessed by \code{\link[=infer_type]{infer_type()}}.}
}
\value{
An \link{Array} with type \code{type}.
}
\description{
The \code{as_arrow_array()} function is identical to \code{Array$create()} except
that it is an S3 generic, which allows methods to be defined in other
packages to convert objects to \link{Array}. \code{Array$create()} is slightly faster
because it tries to convert in C++ before falling back on
\code{as_arrow_array()}.
}
\examples{
as_arrow_array(1:5)

}