ianmcook commented on a change in pull request #9916:
URL: https://github.com/apache/arrow/pull/9916#discussion_r609294737
##########
File path: r/R/compute.R
##########
@@ -34,6 +48,30 @@ call_function <- function(function_name, ..., args =
list(...), options = empty_
compute__CallFunction(function_name, args, options)
}
+#' List available Arrow C++ compute functions
+#'
+#' This function lists the names of all available Arrow compute functions.
+#' These can be called by passing to [call_function()], or they can be
+#' called by name with an `arrow_` prefix inside a `dplyr` verb.
+#'
+#' The resulting list describes the capabilities of your `arrow` build.
+#' Some functions, such as string and regular expression functions,
+#' require optional build-time C++ dependencies. If your `arrow` package
+#' was not compiled with those features enabled, those functions will
+#' not appear in this list.
+#'
Review comment:
I'd suggest adding an additional paragraph here saying something like:
>This is not a complete list of all the compute functions available in the
`arrow` R package. The R package also includes Arrow translations of many base
R functions and some popular functions from tidyverse packages that can be
called directly on Arrow objects or inside `dplyr` verbs.
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
