Fixes Open-Systems-Pharmacology#304 add enum helper for ticklabels

NAMESPACE

@@ -78,6 +78,7 @@ export(ThemeAestheticSelections)
 export(ThemeBackground)
 export(ThemeFont)
 export(ThemePlotConfigurations)
+export(TickLabelTransforms)
 export(TimeProfileDataMapping)
 export(TimeProfilePlotConfiguration)
 export(TornadoDataMapping)
@@ -98,6 +99,7 @@ export(exportPlot)
 export(exportPlotConfigurationCode)
 export(getBoxWhiskerMeasure)
 export(getDefaultCaptions)
+export(getGreekTickLabels)
 export(getGuestValues)
 export(getGuestValuesFromDataMapping)
 export(getLabelWithUnit)
@@ -107,6 +109,7 @@ export(getLinesFromFoldDistance)
 export(getLnTickLabels)
 export(getLogTickLabels)
 export(getPKRatioMeasure)
+export(getPiTickLabels)
 export(getSqrtTickLabels)
 export(initializePlot)
 export(loadThemeFromJson)

NEWS.md

@@ -13,6 +13,7 @@
    - `HorizontalJustification` (horizontal justifications for plot annotation text) (#293)
    - `VerticalJustification` (vertical justifications for plot annotation text) (#293)
    - `PlotAnnotationTextSize` (default text sizes for plot annotations) (#293)
+   - `TickLabelTransforms` (predefined tick labeling) (#304)
 
 ## Minor improvements and bug fixes
 

R/plotconfiguration-axis.R

@@ -38,6 +38,32 @@ createPlotTicks <- function(ticks) {
   return(ticks)
 }
 
+#' @title createPlotTickLabels
+#' @description Translate ticks and ticklabels into a value directly usable by `ggplot2`
+#' to give more flexibilty in the next functions
+#' @param ticklabels character, numeric or function defining the ticks
+#' @return name of the `ggplot2` scale
+#' @keywords internal
+createPlotTickLabels <- function(ticklabels) {
+  if (isEmpty(ticklabels)) {
+    return(waiver())
+  }
+  if (isIncluded(ticklabels, TickLabelTransforms)) {
+    transformedLabels <- switch(ticklabels,
+      "default" = waiver(),
+      "none" = NULL,
+      "identity" = identity,
+      "log" = getLogTickLabels,
+      "ln" = getLnTickLabels,
+      "sqrt" = getSqrtTickLabels,
+      "greek" = getGreekTickLabels,
+      "pi" = getPiTickLabels
+    )
+    return(transformedLabels)
+  }
+  return(ticklabels)
+}
+
 #' @title AxisConfiguration
 #' @description  R6 class defining the configuration of axis
 #' @export
@@ -69,7 +95,7 @@ AxisConfiguration <- R6::R6Class(
       scale <- scale %||% Scaling$lin
       private$.scale <- createPlotScale(scale)
       private$.ticks <- createPlotTicks(ticks)
-      private$.ticklabels <- createPlotTicks(ticklabels)
+      private$.ticklabels <- createPlotTickLabels(ticklabels)
       private$.expand <- expand
 
       # Default axis font will use theme
@@ -176,7 +202,7 @@ AxisConfiguration <- R6::R6Class(
       if (missing(value)) {
         return(private$.ticklabels)
       }
-      private$.ticklabels <- createPlotTicks(value)
+      private$.ticklabels <- createPlotTickLabels(value)
       return(invisible())
     },
     #' @field font `Font` object defining the font of the ticklabels

R/utilities-axis.R

@@ -142,3 +142,58 @@ getSqrtTickLabels <- function(ticks) {
   sqrtValues <- ticks^2
   return(parse(text = paste("sqrt(", sqrtValues, ")", sep = "")))
 }
+
+#' @title getGreekTickLabels
+#' @description Get ticklabels expressions for discrete scale plots with greek letters
+#' @param ticks numeric values of the ticks
+#' @return Expressions to use in `ticklabels` input parameter of `setXAxis` and `setYAxis` functions
+#' @examples
+#' ticks <- c(1, 5, 10, 50, 100, 500))
+#' getGreekTickLabels(ticks)
+#' @export
+getGreekTickLabels <- function(ticks) {
+  # alpha starts at converted integer 945
+  if(is.numeric(ticks)){
+    return(sapply(ticks, function(tick){intToUtf8(tick + 944)}))
+  }
+  tickLabels <- sapply(1:length(ticks), function(tick){intToUtf8(tick + 944)})
+  return(tickLabels)
+}
+
+#' @title getPiTickLabels
+#' @description Get ticklabels expressions for plots with values as ratios of Pi
+#' @param ticks numeric values of the ticks
+#' @return Expressions to use in `ticklabels` input parameter of `setXAxis` and `setYAxis` functions
+#' @examples
+#' ticks <- seq(0, 2*pi, pi/2)
+#' getPiTickLabels(ticks)
+#' @export
+getPiTickLabels <- function(ticks) {
+  # Get fractions of pi from ticks
+  roundPi <- as.character(ticks %/% pi)
+  # Remove 1 and -1 from expression
+  roundPi[roundPi=="1"] <- ""
+  roundPi[roundPi=="-1"] <- "-"
+  # Flag when 0 to remove pi from label
+  roundPi[roundPi=="0"] <- "x"
+
+  roundPi <- paste(roundPi, "\u03C0", sep = "")
+  roundPi[grepl("x", roundPi)] <- ""
+
+  # Round to 3 digits to get fraction values
+  # If fraction is recognized, used fraction format
+  decPi <- round((ticks %% pi)/pi, 3)
+  decPi <- sapply(decPi, function(piFraction){
+    if(piFraction==0){return("")}
+    if(piFraction==0.167){return(" + \u03C0/6")}
+    if(piFraction==0.25){return(" + \u03C0/4")}
+    if(piFraction==0.333){return(" + \u03C0/3")}
+    if(piFraction==0.5){return(" + \u03C0/2")}
+    if(piFraction==0.667){return(" + 2\u03C0/3")}
+    if(piFraction==0.667){return(" + 5\u03C0/6")}
+    return(paste0("+", piFraction, "\u03C0"))
+  })
+  piLabels <- paste(roundPi, decPi, sep = "")
+  piLabels[piLabels==""] <- "0"
+  return(piLabels)
+}

R/utilities-enums.R

@@ -320,3 +320,11 @@ ExportUnits <- enum(c("cm", "in", "mm", "px"))
 #' List of all available formats to export a ggplot object
 #' @family enum helpers
 ExportFormats <- enum(c("png", "pdf", "eps", "ps", "tex", "jpeg", "tiff", "bmp", "svg", "wmf"))
+
+#' @title TickLabelTransforms
+#' @import ospsuite.utils
+#' @export
+#' @description
+#' List of all available tick label transformation names
+#' @family enum helpers
+TickLabelTransforms <- enum(c("none", "default", "identity", "log", "ln", "sqrt", "greek", "pi"))