This is an automated email from the ASF dual-hosted git repository.
amoeba 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 f5183b133b MINOR: [R][Doc] Re-sync Roxygen docs and fix link to
parse_value_mapping (#49864)
f5183b133b is described below
commit f5183b133ba00f188928abea0ab893d2a07c460b
Author: Bryce Mecum <[email protected]>
AuthorDate: Mon Apr 27 21:03:09 2026 -0700
MINOR: [R][Doc] Re-sync Roxygen docs and fix link to parse_value_mapping
(#49864)
### Rationale for this change
The checked in docs are out of sync with the result of `make doc` and,
additionally, roxygen was complaining about the `parse_value_mapping` link
since it's `noRd`. I saw these during the submission to CRAN and needed to fix
this on main.
### What changes are included in this PR?
- De-linked parse_value_mapping
- Re-ran `make doc`
### Are these changes tested?
No.
### Are there any user-facing changes?
No.
Authored-by: Bryce Mecum <[email protected]>
Signed-off-by: Bryce Mecum <[email protected]>
---
r/R/dplyr-funcs-conditional.R | 2 +-
r/man/Field-class.Rd | 16 +++++++++++++++-
r/man/Field.Rd | 6 ++++--
r/man/acero.Rd | 2 +-
4 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/r/R/dplyr-funcs-conditional.R b/r/R/dplyr-funcs-conditional.R
index b2d5a6ac79..7bf2449e82 100644
--- a/r/R/dplyr-funcs-conditional.R
+++ b/r/R/dplyr-funcs-conditional.R
@@ -18,7 +18,7 @@
#' Parse logical condition formulas
#'
#' Converts condition ~ value formulas into Arrow expressions. Unlike
-#' [parse_value_mapping()], the LHS must be a logical expression (not a value
+#' `parse_value_mapping()`, the LHS must be a logical expression (not a value
#' to match against).
#'
#' @param formulas A list of two-sided formulas where LHS is a logical
condition
diff --git a/r/man/Field-class.Rd b/r/man/Field-class.Rd
index 35d8e236b2..4335556b8c 100644
--- a/r/man/Field-class.Rd
+++ b/r/man/Field-class.Rd
@@ -13,7 +13,21 @@
\itemize{
\item \code{f$ToString()}: convert to a string
-\item \code{f$Equals(other)}: test for equality. More naturally called as
\code{f == other}
+\item \code{f$Equals(other, check_metadata = FALSE)}: test for equality.
+More naturally called as \code{f == other}
+\item \code{f$WithMetadata(metadata)}: returns a new \code{Field} with the
key-value
+\code{metadata} set. Note that all list elements in \code{metadata} will be
coerced
+to \code{character}.
+\item \code{f$RemoveMetadata()}: returns a new \code{Field} without metadata.
+}
+}
+
+\section{Active bindings}{
+
+\itemize{
+\item \verb{$HasMetadata}: logical: does this \code{Field} have extra metadata?
+\item \verb{$metadata}: returns the key-value metadata as a named list, or
\code{NULL}
+if no metadata is set.
}
}
diff --git a/r/man/Field.Rd b/r/man/Field.Rd
index 4d6fadcad3..087a106b18 100644
--- a/r/man/Field.Rd
+++ b/r/man/Field.Rd
@@ -4,14 +4,15 @@
\alias{field}
\title{Create a Field}
\usage{
-field(name, type, metadata, nullable = TRUE)
+field(name, type, metadata = NULL, nullable = TRUE)
}
\arguments{
\item{name}{field name}
\item{type}{logical type, instance of \link{DataType}}
-\item{metadata}{currently ignored}
+\item{metadata}{a named character vector or list to attach as field metadata.
+All values will be coerced to \code{character}.}
\item{nullable}{TRUE if field is nullable}
}
@@ -20,6 +21,7 @@ Create a Field
}
\examples{
field("x", int32())
+field("x", int32(), metadata = list(key = "value"))
}
\seealso{
\link{Field}
diff --git a/r/man/acero.Rd b/r/man/acero.Rd
index f721aa5d9f..2e8b1fba1e 100644
--- a/r/man/acero.Rd
+++ b/r/man/acero.Rd
@@ -72,7 +72,7 @@ can assume that the function works in Acero just as it does
in R.
Functions can be called either as \code{pkg::fun()} or just \code{fun()}, i.e.
both
\code{str_sub()} and \code{stringr::str_sub()} work.
-In addition to these functions, you can call any of Arrow's 253 compute
+In addition to these functions, you can call any of Arrow's 281 compute
functions directly. Arrow has many functions that don't map to an existing R
function. In other cases where there is an R function mapping, you can still
call the Arrow function directly if you don't want the adaptations that the R
