[formula] add name argument to wb_add_formula()

Author: JanMarvin

R/class-workbook-wrappers.R

@@ -696,6 +696,7 @@ wb_remove_timeline <- function(
 #' @param remove_cell_style Should we keep the cell style?
 #' @param enforce enforce dims
 #' @param shared shared formula
+#' @param name The name of a named region if specified.
 #' @param ... additional arguments
 #' @return The workbook, invisibly.
 #' @family workbook wrappers
@@ -738,6 +739,7 @@ wb_add_formula <- function(
     remove_cell_style = FALSE,
     enforce           = FALSE,
     shared            = FALSE,
+    name              = NULL,
     ...
 ) {
   assert_workbook(wb)
@@ -753,6 +755,7 @@ wb_add_formula <- function(
     remove_cell_style = remove_cell_style,
     enforce           = enforce,
     shared            = shared,
+    name              = name,
     ...               = ...
   )
 }

R/class-workbook.R

@@ -2466,6 +2466,7 @@ wbWorkbook <- R6::R6Class(
     #' @param remove_cell_style if writing into existing cells, should the cell style be removed?
     #' @param enforce enforce dims
     #' @param shared shared formula
+    #' @param name name
     #' @return The `wbWorkbook` object
     add_formula = function(
         sheet             = current_sheet(),
@@ -2479,12 +2480,13 @@ wbWorkbook <- R6::R6Class(
         remove_cell_style = FALSE,
         enforce           = FALSE,
         shared            = FALSE,
+        name              = NULL,
         ...
     ) {
 
       standardize_case_names(...)
 
-      if (!is.null(names(x))) {
+      if (is.character(x) && !is.null(names(x)) && is.null(name)) {
         assert_class(x, "character")
         assert_named_region(names(x))
 
@@ -2511,7 +2513,8 @@ wbWorkbook <- R6::R6Class(
         applyCellStyle  = apply_cell_style,
         removeCellStyle = remove_cell_style,
         enforce         = enforce,
-        shared          = shared
+        shared          = shared,
+        name            = name
       )
       invisible(self)
     },

R/write.R

@@ -1189,6 +1189,7 @@ do_write_formula <- function(
     remove_cell_style = FALSE,
     enforce           = FALSE,
     shared            = FALSE,
+    name              = NULL,
     ...
 ) {
   standardize_case_names(...)
@@ -1318,6 +1319,7 @@ do_write_formula <- function(
     array             = array,
     col_names         = FALSE,
     row_names         = FALSE,
+    name              = name,
     apply_cell_style  = apply_cell_style,
     remove_cell_style = remove_cell_style,
     enforce           = enforce,

man/wbWorkbook.Rd

@@ -212,4 +212,7 @@ test_that("registering formulas works", {
   expect_message(wb$add_formula(x = c(YESTERDAY = fml)), "formula registered to the workbook")
   expect_equal(wb$get_named_regions()$value, fml)
 
+  wb <- wb_add_formula(wb, x = "YESTERDAY()", name = "YSTRDY", array = TRUE)
+  expect_equal(wb$get_named_regions()$name, c("YESTERDAY", "YSTRDY"))
+
 })