This function provides a lower-level API for calling Arrow functions by their
string function name. You won't use it directly for most applications.
Many Arrow compute functions are mapped to R methods,
and in a dplyr
evaluation context, all Arrow functions
are callable with an arrow_
prefix.
call_function(
function_name,
...,
args = list(...),
options = empty_named_list()
)
string Arrow compute function name
Function arguments, which may include Array
, ChunkedArray
, Scalar
,
RecordBatch
, or Table
.
list arguments as an alternative to specifying in ...
named list of C++ function options.
An Array
, ChunkedArray
, Scalar
, RecordBatch
, or Table
, whatever the compute function results in.
When passing indices in ...
, args
, or options
, express them as
0-based integers (consistent with C++).
Arrow C++ documentation for the functions and their respective options.
a <- Array$create(c(1L, 2L, 3L, NA, 5L))
s <- Scalar$create(4L)
call_function("coalesce", a, s)
#> Array
#> <int32>
#> [
#> 1,
#> 2,
#> 3,
#> 4,
#> 5
#> ]
a <- Array$create(rnorm(10000))
call_function("quantile", a, options = list(q = seq(0, 1, 0.25)))
#> Array
#> <double>
#> [
#> -3.3079202402939125,
#> -0.6553640965661327,
#> 0.020153451466365043,
#> 0.6590683987315568,
#> 3.4853337505589033
#> ]