Implemented replace(), a drop-in replacement for base::replace() that allows list= and values= to be functions.

Author: krivit

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: statnet.common
-Version: 4.12.0-483
-Date: 2025-05-19
+Version: 4.12.0-487
+Date: 2025-05-29
 Title: Common R Scripts and Utilities Used by the Statnet Project Software
 Authors@R: c(
     person(c("Pavel", "N."), "Krivitsky", role=c("aut","cre"), email="pavel@statnet.org", comment=c(ORCID="0000-0002-9101-3362", affiliation="University of New South Wales")),
@@ -19,6 +19,7 @@ Encoding: UTF-8
 Suggests: covr,
           roxygen2,
           rlang (>= 1.1.1),
+          purrr,
           MASS
 Remotes:
     krivit/roxygen2@anchor-sometimes

NAMESPACE

@@ -121,6 +121,7 @@ export(persistEval)
 export(persistEvalQ)
 export(qrsolve)
 export(qrssolve)
+export(replace)
 export(rowweights)
 export(sandwich_ginv)
 export(sandwich_qrsolve)

R/misc.utilities.R

@@ -1199,3 +1199,57 @@ modify_in_place <- function(x, value = x){
 
   invisible(value) # Return invisibly.
 }
+
+#' Replace values in a vector according to functions
+#'
+#' This is a thin wrapper around [base::replace()] that allows `list`
+#' and/or `values` to be functions that are evaluated on `x` to obtain
+#' the replacement indices and values.
+#'
+#' `list` function is passed the whole vector `x` at once (not
+#' elementwise) and any additional arguments to `replace()`, and must
+#' return an indexing vector (numeric, logical, character,
+#' etc.). `values` function is passed `x` after subsetting it by the
+#' result of calling `list()`.
+#'
+#' If passing named arguments, `x`, `list`, and `values` may cause a
+#' conflict.
+#'
+#' @param x a vector.
+#' @param list either an index vector or a function (*not* a function
+#'   name).
+#' @param values either a vector of replacement values or a function
+#'   (*not* a function name).
+#' @param ... additional arguments to `list` if it is a function;
+#'   otherwise ignored.
+#'
+#' @return A vector with the values replaced.
+#'
+#' @seealso [purrr::modify()] family of functions.
+#'
+#' @examples
+#'
+#' (x <- rnorm(10))
+#'
+#' ### Replace elements of x that are < 1/4 with 0.
+#'
+#' # Note that this code is pipeable.
+#' x |> replace(`<`, 0, 1/4)
+#' # More readable, using lambda notation.
+#' x |> replace(\(.x) .x < 1/4, 0)
+#' # base equivalent.
+#' stopifnot(identical(replace(x, `<`, 0, 1/4),
+#'                     base::replace(x, x < 1/4, 0)))
+#'
+#' ### Multiply negative elements of x by 1i.
+#'
+#' x |> replace(\(.x) .x < 0, \(.x) .x * 1i)
+#' stopifnot(identical(replace(x, \(.x) .x < 0, \(.x) .x * 1i),
+#'                     base::replace(x, x < 0, x[x < 0] * 1i)))
+#'
+#' @export
+replace <- function(x, list, values, ...) {
+  if (is.function(list)) list <- list(x, ...)
+  if (is.function(values)) values <- values(x[list], ...)
+  base::replace(x, list, values)
+}