This is an automated email from the ASF dual-hosted git repository.
brycemecum pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 6750eccf94 GH-43509: [R] Add link to ?acero from
?list_compute_functions (#44210)
6750eccf94 is described below
commit 6750eccf94de0bc6770ba56116acfb5094aa7d90
Author: Nic Crane <[email protected]>
AuthorDate: Thu Sep 26 16:58:42 2024 +0100
GH-43509: [R] Add link to ?acero from ?list_compute_functions (#44210)
### Rationale for this change
Add link between docs pages to make it easier to find relevant information
### What changes are included in this PR?
Update docs
### Are these changes tested?
Nope
### Are there any user-facing changes?
Sure, to the docs
* GitHub Issue: #43509
Authored-by: Nic Crane <[email protected]>
Signed-off-by: Bryce Mecum <[email protected]>
---
r/R/compute.R | 1 +
r/man/list_compute_functions.Rd | 3 +++
2 files changed, 4 insertions(+)
diff --git a/r/R/compute.R b/r/R/compute.R
index 9848de0372..1ae1648bcf 100644
--- a/r/R/compute.R
+++ b/r/R/compute.R
@@ -88,6 +88,7 @@ call_function <- function(function_name, ..., args =
list(...), options = empty_
#' @param pattern Optional regular expression to filter the function list
#' @param ... Additional parameters passed to `grep()`
#' @return A character vector of available Arrow C++ function names
+#' @seealso [acero] for R bindings for Arrow functions
#' @examples
#' available_funcs <- list_compute_functions()
#' utf8_funcs <- list_compute_functions(pattern = "^UTF8", ignore.case = TRUE)
diff --git a/r/man/list_compute_functions.Rd b/r/man/list_compute_functions.Rd
index e722fd80e4..da11d50fa3 100644
--- a/r/man/list_compute_functions.Rd
+++ b/r/man/list_compute_functions.Rd
@@ -41,3 +41,6 @@ available inside \code{dplyr} verbs.
available_funcs <- list_compute_functions()
utf8_funcs <- list_compute_functions(pattern = "^UTF8", ignore.case = TRUE)
}
+\seealso{
+\link{acero} for R bindings for Arrow functions
+}