Merge pull request #502 from JanMarvin/colour_color_pt2

Colour color pt2

Author: JanMarvin

NAMESPACE

@@ -141,7 +141,7 @@ import(R6)
 import(Rcpp)
 importFrom(grDevices,bmp)
 importFrom(grDevices,col2rgb)
-importFrom(grDevices,colours)
+importFrom(grDevices,colors)
 importFrom(grDevices,dev.copy)
 importFrom(grDevices,dev.list)
 importFrom(grDevices,dev.off)

NEWS.md

@@ -6,7 +6,7 @@
 
 * `writeData()` calls `force(x)` to evaluate the object before options are set ([#264](https://github.com/ycphs/openxlsx/issues/264))
 
-* `tabColour` in `wb_add_worksheet()` now allows passing `wb_colour()`. [500](https://github.com/JanMarvin/openxlsx2/pull/500)
+* `tabColor` in `wb_add_worksheet()` now allows passing `wb_color()`. [500](https://github.com/JanMarvin/openxlsx2/pull/500)
 
 ## Fixes
 
@@ -24,6 +24,8 @@
 
 * Do not export `write_data2()` anymore. This was used in development in the early stages of the package and should not be used directly anymore.
 
+* Only documentation: `openxlsx2` defaults to american english 'color' from now on. Though, we fully support the previous 'colour'. Users will not have to adjust their code. Our documentation only lists `color`, but you can pass `colour` just the same way you used to. [501](https://github.com/JanMarvin/openxlsx2/pull/501) [502](https://github.com/JanMarvin/openxlsx2/pull/502)
+
 
 ***************************************************************************
 
@@ -158,7 +160,7 @@
 
 * New argument `startCol` in read to data frame functions `wb_to_df()`, `wb_read()` and `read_xlsx()`. [330](https://github.com/JanMarvin/openxlsx2/issues/330)
 
-* New function `wb_colour()` to ease working with colour vectors used in `openxlsx2` styles. [292](https://github.com/JanMarvin/openxlsx2/issues/292)
+* New function `wb_colour()` to ease working with color vectors used in `openxlsx2` styles. [292](https://github.com/JanMarvin/openxlsx2/issues/292)
 
 * Deprecated `get_cell_style()` and `set_cell_style()` in favor of newly introduced wrapper functions `wb_get_cell_style()` and `wb_set_cell_style()`. [306](https://github.com/JanMarvin/openxlsx2/issues/306)
 

R/asserts.R

@@ -51,27 +51,27 @@ match_oneof <- function(x, y, or_null = FALSE, several = FALSE, envir = parent.f
   y[m]
 }
 
-validate_colour <- function(colour = NULL, or_null = FALSE, envir = parent.frame()) {
-  sx <- as.character(substitute(colour, envir))
+validate_color <- function(color = NULL, or_null = FALSE, envir = parent.frame()) {
+  sx <- as.character(substitute(color, envir))
 
-  if (identical(colour, "none") && or_null) {
+  if (identical(color, "none") && or_null) {
     return(NULL)
   }
 
   # returns black
-  if (is.null(colour)) {
+  if (is.null(color)) {
     if (or_null) return(NULL)
     return("FF000000")
   }
 
-  if (ind <- any(colour %in% grDevices::colours())) {
-    colour[ind] <- col2hex(colour[ind])
+  if (ind <- any(color %in% grDevices::colors())) {
+    color[ind] <- col2hex(color[ind])
   }
 
-  if (any(!grepl("^#[A-Fa-f0-9]{6}$", colour))) {
-    msg <- sprintf("`%s` ['%s'] is not a valid colour", sx, colour)
+  if (any(!grepl("^#[A-Fa-f0-9]{6}$", color))) {
+    msg <- sprintf("`%s` ['%s'] is not a valid color", sx, color)
     stop(simpleError(msg))
   }
 
-  gsub("^#", "FF", toupper(colour))
+  gsub("^#", "FF", toupper(color))
 }

R/baseXML.R

@@ -483,20 +483,20 @@ genBaseTheme <- function() {
   )
 }
 
-gen_databar_extlst <- function(guid, sqref, posColour, negColour, values, border, gradient) {
+gen_databar_extlst <- function(guid, sqref, posColor, negColor, values, border, gradient) {
   xml <- sprintf('<x14:cfRule type="dataBar" id="{%s}"><x14:dataBar minLength="0" maxLength="100" border="%s" gradient = "%s" negativeBarBorderColorSameAsPositive="0">', guid, border, gradient)
 
   if (is.null(values)) {
     xml <- sprintf('<ext uri="{78C0D931-6437-407d-A8EE-F0AAD7539E65}" xmlns:x14="http://schemas.microsoft.com/office/spreadsheetml/2009/9/main"><x14:conditionalFormattings><x14:conditionalFormatting xmlns:xm="http://schemas.microsoft.com/office/excel/2006/main">
                       %s
                       <x14:cfvo type="autoMin"/><x14:cfvo type="autoMax"/><x14:borderColor rgb="%s"/><x14:negativeFillColor rgb="%s"/><x14:negativeBorderColor rgb="%s"/><x14:axisColor rgb="FF000000"/>
-                      </x14:dataBar></x14:cfRule><xm:sqref>%s</xm:sqref></x14:conditionalFormatting></x14:conditionalFormattings></ext>', xml, posColour, negColour, negColour, sqref)
+                      </x14:dataBar></x14:cfRule><xm:sqref>%s</xm:sqref></x14:conditionalFormatting></x14:conditionalFormattings></ext>', xml, posColor, negColor, negColor, sqref)
   } else {
     xml <- sprintf('<ext uri="{78C0D931-6437-407d-A8EE-F0AAD7539E65}" xmlns:x14="http://schemas.microsoft.com/office/spreadsheetml/2009/9/main"><x14:conditionalFormattings><x14:conditionalFormatting xmlns:xm="http://schemas.microsoft.com/office/excel/2006/main">
                       %s
                       <x14:cfvo type="num"><xm:f>%s</xm:f></x14:cfvo><x14:cfvo type="num"><xm:f>%s</xm:f></x14:cfvo>
                       <x14:borderColor rgb="%s"/><x14:negativeFillColor rgb="%s"/><x14:negativeBorderColor rgb="%s"/><x14:axisColor rgb="FF000000"/>
-                      </x14:dataBar></x14:cfRule><xm:sqref>%s</xm:sqref></x14:conditionalFormatting></x14:conditionalFormattings></ext>', xml, values[[1]], values[[2]], posColour, negColour, negColour, sqref)
+                      </x14:dataBar></x14:cfRule><xm:sqref>%s</xm:sqref></x14:conditionalFormatting></x14:conditionalFormattings></ext>', xml, values[[1]], values[[2]], posColor, negColor, negColor, sqref)
   }
 
   return(xml)

R/class-chart-sheet.R

@@ -27,16 +27,16 @@ wbChartSheet <- R6::R6Class(
 
     #' @description
     #' Create a new workbook chart sheet object
-    #' @param tabColour `character` a tab colour to set
+    #' @param tabColor `character` a tab color to set
     #' @return The `wbChartSheet` object
-    initialize = function(tabColour = tabColour) {
-      if (length(tabColour)) {
-        tabColour <- sprintf('<sheetPr><tabColor rgb="%s"/></sheetPr>', tabColour)
+    initialize = function(tabColor = tabColor) {
+      if (length(tabColor)) {
+        tabColor <- sprintf('<sheetPr><tabColor rgb="%s"/></sheetPr>', tabColor)
       } else {
-        tabColour <- character()
+        tabColor <- character()
       }
 
-      self$sheetPr     <- tabColour
+      self$sheetPr     <- tabColor
       self$sheetViews  <- character()
       self$pageMargins <- '<pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/>'
       self$drawing     <- '<drawing r:id=\"rId1\"/>'

R/class-color.R

@@ -8,7 +8,7 @@
 #' @return a `wbColour` object
 #' @rdname wbColour
 #' @export
-wb_colour <- function(
+wb_color <- function(
     name = NULL,
     auto = NULL,
     indexed = NULL,
@@ -17,7 +17,7 @@ wb_colour <- function(
     tint = NULL
   ) {
 
-  if (!is.null(name)) hex <-  validate_colour(name)
+  if (!is.null(name)) hex <-  validate_color(name)
 
   z <- c(
     auto    = auto,
@@ -30,53 +30,33 @@ wb_colour <- function(
   if (is.null(z))
     z <- c(name = "black")
 
+  # wbColour for historical reasons
   class(z) <- c("character", "wbColour")
   z
 }
 
 #' @export
 #' @rdname wbColour
 #' @usage NULL
-wb_color <- wb_colour
+wb_colour <- wb_color
 
 is_wbColour <- function(x) inherits(x, "wbColour")
 
-#' takes color and returns colour
-#' @param ... ...
-#' @returns named colour argument
-#' @keywords internal
-#' @noRd
-standardise_color_names <- function(...) {
-
-  got <- ...names()
-  # can be Colour or colour
-  got_colour <- which(grepl("color", tolower(got)))
-
-  if (length(got_colour)) {
-    for (got_col in got_colour) {
-      colour <- got[got_col]
-      name_color <- stringi::stri_replace_all_fixed(colour, "olor", "olour", )
-      value_color <- ...elt(got_col)
-      assign(name_color, value_color, parent.frame())
-    }
-  }
-}
-
 #' takes colour and returns color
 #' @param ... ...
-#' @returns named color argument
+#' @returns void. assigns an object in the parent frame
 #' @keywords internal
 #' @noRd
-standardize_colour_names <- function(...) {
+standardize_color_names <- function(...) {
 
   got <- ...names()
-  # can be Colour or colour
-  got_colour <- which(grepl("colour", tolower(got)))
+  # can be Color or color
+  got_color <- which(grepl("colour", tolower(got)))
 
-  if (length(got_colour)) {
-    for (got_col in got_colour) {
-      colour <- got[got_col]
-      name_color <- stringi::stri_replace_all_fixed(colour, "olour", "olor", )
+  if (length(got_color)) {
+    for (got_col in got_color) {
+      color <- got[got_col]
+      name_color <- stringi::stri_replace_all_fixed(color, "olour", "olor", )
       value_color <- ...elt(got_col)
       assign(name_color, value_color, parent.frame())
     }

R/class-comment.R

@@ -66,7 +66,7 @@ wbComment <- R6::R6Class(
           styleShow,
           sprintf("Font name: %s\n", unname(unlist(xml_attr(s[[i]], "font", "name")))), ## Font name
           sprintf("Font size: %s\n", unname(unlist(xml_attr(s[[i]], "font", "sz")))), ## Font size
-          sprintf("Font colour: %s\n", gsub("^FF", "#", unname(unlist(xml_attr(s[[i]], "font", "color"))))), ## Font colour
+          sprintf("Font color: %s\n", gsub("^FF", "#", unname(unlist(xml_attr(s[[i]], "font", "color"))))), ## Font color
           "\n\n"
         )
       }
@@ -111,8 +111,8 @@ wbComment <- R6::R6Class(
 #' write_comment(wb, 1, col = "C", row = 10, comment = c2)
 #'
 #' # write a styled comment with system author
-#' s1 <- create_font(b = "true", color = wb_colour(hex = "FFFF0000"), sz = "12")
-#' s2 <- create_font(color = wb_colour(hex = "FF000000"), sz = "9")
+#' s1 <- create_font(b = "true", color = wb_color(hex = "FFFF0000"), sz = "12")
+#' s2 <- create_font(color = wb_color(hex = "FF000000"), sz = "9")
 #' c3 <- create_comment(text = c("This Part Bold red\n\n", "This part black"), style = c(s1, s2))
 #'
 #' write_comment(wb, 1, col = 6, row = 3, comment = c3)

R/class-style_mgr.R

@@ -25,15 +25,15 @@
 #'
 #' ## create and add huge font
 #' new_huge_font <- create_font(sz = "20", name = "Arial", b = "1",
-#'                              color = wb_colour(hex = "FFFFFFFF"))
+#'                              color = wb_color(hex = "FFFFFFFF"))
 #' wb$styles_mgr$add(new_huge_font, "arial_huge")
 #'
 #' ## create another font
 #' new_font <- create_font(name = "Arial")
 #' wb$styles_mgr$add(new_font, "arial")
 #'
 #' ## create and add new fill
-#' new_fill <- create_fill(patternType = "solid", fgColor = wb_colour(hex = "FF00224B"))
+#' new_fill <- create_fill(patternType = "solid", fgColor = wb_color(hex = "FF00224B"))
 #' wb$styles_mgr$add(new_fill, "blue")
 #'
 #' # create new style with numfmt enabled