[formula] switch to named formula for registering of formulas

Author: JanMarvin

R/class-workbook-wrappers.R

@@ -696,7 +696,6 @@ wb_remove_timeline <- function(
 #' @param remove_cell_style Should we keep the cell style?
 #' @param enforce enforce dims
 #' @param shared shared formula
-#' @param name A function name to access the custom formula
 #' @param ... additional arguments
 #' @return The workbook, invisibly.
 #' @family workbook wrappers
@@ -723,7 +722,7 @@ wb_remove_timeline <- function(
 #'  add_formula(x = "SUM($A2:A2)", dims = "A8:E12", shared = TRUE)
 #'
 #' # add a custom formula, first define it, then use it
-#' wb$add_formula(x = "_xlfn.LAMBDA(TODAY() - 1)", name = "YESTERDAY")
+#' wb$add_formula(x = c(YESTERDAY = "_xlfn.LAMBDA(TODAY() - 1)"))
 #' wb$add_formula(x = "=YESTERDAY()", dims = "A1", cm = TRUE)
 #'
 wb_add_formula <- function(
@@ -739,7 +738,6 @@ wb_add_formula <- function(
     remove_cell_style = FALSE,
     enforce           = FALSE,
     shared            = FALSE,
-    name              = NULL,
     ...
 ) {
   assert_workbook(wb)
@@ -755,7 +753,6 @@ wb_add_formula <- function(
     remove_cell_style = remove_cell_style,
     enforce           = enforce,
     shared            = shared,
-    name              = name,
     ...               = ...
   )
 }

R/class-workbook.R

@@ -2466,7 +2466,6 @@ 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(),
@@ -2480,21 +2479,19 @@ wbWorkbook <- R6::R6Class(
         remove_cell_style = FALSE,
         enforce           = FALSE,
         shared            = FALSE,
-        name              = NULL,
         ...
     ) {
 
       standardize_case_names(...)
 
-      if (!is.null(name)) {
+      if (!is.null(names(x))) {
         assert_class(x, "character")
-        assert_named_region(x)
-        assert_class(name, "character")
+        assert_named_region(names(x))
 
         xml <- xml_node_create(
           "definedName",
           xml_children = x,
-          xml_attributes = c(name = name)
+          xml_attributes = c(name = names(x))
         )
         private$append_workbook_field("definedNames", xml)
 

man/wbWorkbook.Rd

@@ -207,9 +207,9 @@ test_that("increase formula dims if required", {
 test_that("registering formulas works", {
 
   fml <- "_xlfn.LAMBDA(TODAY() - 1)"
-  wb <- wb_workbook()$add_worksheet()$
-    add_formula(x = fml, name = "YESTERDAY")
+  wb <- wb_workbook()$add_worksheet()
 
+  expect_message(wb$add_formula(x = c(YESTERDAY = fml)), "formula registered to the workbook")
   expect_equal(wb$get_named_regions()$value, fml)
 
 })