Add rename functions

NAMESPACE

@@ -72,6 +72,10 @@ export(remove_evaluator)
 export(remove_method)
 export(remove_vary_across)
 export(remove_visualizer)
+export(rename_dgps)
+export(rename_evaluators)
+export(rename_methods)
+export(rename_visualizers)
 export(render_docs)
 export(run_experiment)
 export(run_tests)

R/experiment-helpers.R

@@ -738,6 +738,64 @@ remove_visualizer <- function(experiment, name = NULL, ...) {
   experiment$remove_visualizer(name, ...)
 }
 
+#' Helper functions for renaming components in an `Experiment`.
+#'
+#' @description Helper functions for renaming `DGPs`,
+#'   `Methods`, `Evaluators`, and `Visualizers` from an
+#'   `Experiment`. These functions will also rename these objects in the
+#'   cached documentation and results files.
+#'
+#' @inheritParams shared_experiment_helpers_args
+#' @param ... Named character vector of names to rename. Use
+#'   `"new_name" = "old_name"` format.
+#'
+#' @return The original `Experiment` object passed to `remove_*`.
+#'
+#' @name rename_funs
+#' @rdname rename_funs
+#'
+#' @examples
+#' \dontrun{
+#' rename_dgps(experiment, "New DGP1" = "DGP1", "New DGP2" = "DGP2")
+#' rename_methods(experiment, "New Method1" = "Method1")
+#' rename_evaluators(experiment, "New Evaluator1" = "Evaluator1")
+#' rename_visualizers(experiment, "New Visualizer1" = "Visualizer1")
+#' }
+#'
+NULL
+
+#' @rdname rename_funs
+#'
+#' @inherit rename_funs examples
+#' @export
+rename_dgps <- function(experiment, ...) {
+  experiment$rename_dgps(...)
+}
+
+#' @rdname rename_funs
+#'
+#' @inherit rename_funs examples
+#' @export
+rename_methods <- function(experiment, ...) {
+  experiment$rename_methods(...)
+}
+
+#' @rdname rename_funs
+#'
+#' @inherit rename_funs examples
+#' @export
+rename_evaluators <- function(experiment, ...) {
+  experiment$rename_evaluators(...)
+}
+
+#' @rdname rename_funs
+#'
+#' @inherit rename_funs examples
+#' @export
+rename_visualizers <- function(experiment, ...) {
+  experiment$rename_visualizers(...)
+}
+
 # TODO: add @details
 #' Helper functions for getting components in an `Experiment`.
 #'

R/experiment-utils.R

@@ -26,6 +26,28 @@ get_new_method_params <- function(dgp_params, new_fit_params) {
 }
 
 
+#' @keywords internal
+replace_names <- function(obj, old_names, new_names) {
+  for (i in 1:length(old_names)) {
+    old_name <- old_names[i]
+    new_name <- new_names[i]
+    names(obj)[names(obj) == old_name] <- new_name
+  }
+  return(obj)
+}
+
+
+#' @keywords internal
+replace_values <- function(obj, old_values, new_values) {
+  for (i in 1:length(old_values)) {
+    old_value <- old_values[i]
+    new_value <- new_values[i]
+    obj[obj == old_value] <- new_value
+  }
+  return(obj)
+}
+
+
 #' Get the size of an object, including environments.
 #'
 #' @param obj The object to measure. Default is the calling environment.