[clone_worksheet] copy worksheet across workbooks

R/class-workbook-wrappers.R

@@ -734,9 +734,17 @@ wb_add_worksheet <- function(
 #' formulas, charts, pivot tables, etc. may not be updated. Some elements like
 #' named ranges and slicers cannot be cloned yet.
 #'
+#' Cloning from another workbook is still an experimental feature and might not
+#' work reliably. Cloning data, media, charts and tables should work. Slicers
+#' and pivot tables as well as everything everything relying on dxfs styles
+#' (e.g. custom table styles and conditional formatting) is currently not
+#' implemented.
+#' Formula references are not updated to reflect interactions between workbooks.
+#'
 #' @param wb A `wbWorkbook` object
 #' @param old Name of existing worksheet to copy
 #' @param new Name of the new worksheet to create
+#' @param from (optional) Workbook to clone old from
 #' @return The `wbWorkbook` object, invisibly.
 #'
 #' @export
@@ -751,9 +759,26 @@ wb_add_worksheet <- function(
 #' wb$clone_worksheet("Sheet 1", new = "Sheet 2")
 #' # Take advantage of waiver functions
 #' wb$clone_worksheet(old = "Sheet 1")
-wb_clone_worksheet <- function(wb, old = current_sheet(), new = next_sheet()) {
+#'
+#' ## cloning from another workbook
+#'
+#' # create a workbook
+#' wb <- wb_workbook()$
+#' add_worksheet("NOT_SUM")$
+#'   add_data(x = head(iris))$
+#'   add_fill(dims = "A1:B2", color = wb_color("yellow"))$
+#'   add_border(dims = "B2:C3")
+#'
+#' # we will clone this styled chart into another workbook
+#' fl <- system.file("extdata", "oxlsx2_sheet.xlsx", package = "openxlsx2")
+#' wb_from <- wb_load(fl)
+#'
+#' # clone styles and shared strings
+#' wb$clone_worksheet(old = "SUM", new = "SUM", from = wb_from)
+#'
+wb_clone_worksheet <- function(wb, old = current_sheet(), new = next_sheet(), from = NULL) {
   assert_workbook(wb)
-  wb$clone()$clone_worksheet(old = old, new = new)
+  wb$clone()$clone_worksheet(old = old, new = new, from = from)
 }
 
 # worksheets --------------------------------------------------------------