ianmcook commented on a change in pull request #9916:
URL: https://github.com/apache/arrow/pull/9916#discussion_r609279547
##########
File path: r/R/compute.R
##########
@@ -15,10 +15,24 @@
# specific language governing permissions and limitations
# under the License.
+#' Call an Arrow compute function
+#'
+#' This function provides a lower-level API to 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][list_compute_functions()]
+#' are callable with an `arrow_` prefix.
+#' @param function_name string Arrow compute function name
+#' @param ... Function arguments, which may include `Array`, `ChunkedArray`,
`Scalar`,
+#' `RecordBatch`, or `Table`.
+#' @param args list arguments as an alternative to specifying in `...`
+#' @param options named list of C++ function options.
+#' @return An `Array`, `ChunkedArray`, `Scalar`, `RecordBatch`, or `Table`,
whatever the compute function results in.
Review comment:
```suggestion
#' @return An `Array`, `ChunkedArray`, `Scalar`, `RecordBatch`, or `Table`,
whichever the compute function results in.
```
--
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]
