fix decorate grob vp widths for titles and footers when right margin is present

NEWS.md

@@ -8,6 +8,7 @@
 
 ### Bug Fixes
 * Fixed bug in `s_ancova` that prevented statistics from being printed when arm levels include special characters.
+* Fixed bug in `decorate_grob` that prevented the right margins to be respected when adding title and footers decorations.
 
 ### Miscellaneous
 * Began deprecation of the unused `label_all` parameter to `tabulate_survival_biomarkers` and `tabulate_survival_subgroups`, with redirection to the same parameter in their associated `extract_*` functions.

R/decorate_grob.R

@@ -11,14 +11,22 @@
 #'   according to the page width.
 #' @param footnotes (`character`)\cr footnotes. Uses the same formatting rules as `titles`.
 #' @param page (`string` or `NULL`)\cr page numeration. If `NULL` then no page number is displayed.
-#' @param width_titles (`grid::unit`)\cr width of titles.
-#' @param width_footnotes (`grid::unit`)\cr width of footnotes.
+#' @param width_titles (`grid::unit`)\cr width of titles. Usually defined as all the available space
+#'   `grid::unit(1, "npc")`, it is affected by the parameter `outer_margins`. Right margins (`outer_margins[4]`)
+#'   need to be subtracted to the allowed width.
+#' @param width_footnotes (`grid::unit`)\cr width of footnotes. Same default and margin correction as `width_titles`.
 #' @param border (`flag`)\cr whether a border should be drawn around the plot or not.
-#' @param margins (`grid::unit`)\cr margins. A unit object of length 4.
-#' @param padding (`grid::unit`)\cr padding. A unit object of length 4.
-#' @param outer_margins (`grid::unit`)\cr outer margins. A unit object of length 4.
-#' @param gp_titles (`gpar`)\cr a `gpar` object.
-#' @param gp_footnotes (`gpar`)\cr a `gpar` object.
+#' @param padding (`grid::unit`)\cr padding. A unit object of length 4. Innermost margin between the plot (`grob`)
+#'   and, possibly, the border of the plot. Usually expressed in 4 identical values (usually `"lines"`). It defaults
+#'   to `grid::unit(rep(1, 4), "lines")`.
+#' @param margins (`grid::unit`)\cr margins. A unit object of length 4. Margins between the plot and the other
+#'   elements in the list (e.g. titles, plot, and footers). This is usually expressed in 4 `"lines"`, where the
+#'   lateral ones are 0s, while top and bottom are 1s. It defaults to `grid::unit(c(1, 0, 1, 0), "lines")`.
+#' @param outer_margins (`grid::unit`)\cr outer margins. A unit object of length 4. It defines the general margin of
+#'   the plot, considering also decorations like titles, footnotes, and page numbers. It defaults to
+#'   `grid::unit(c(2, 1.5, 3, 1.5), "cm")`.
+#' @param gp_titles (`gpar`)\cr a `gpar` object. Mainly used to set different `"fontsize"`.
+#' @param gp_footnotes (`gpar`)\cr a `gpar` object. Mainly used to set different `"fontsize"`.
 #'
 #' @return A grid grob (`gTree`).
 #'
@@ -132,17 +140,24 @@ decorate_grob <- function(grob,
                           titles,
                           footnotes,
                           page = "",
-                          width_titles = grid::unit(1, "npc") - grid::unit(1.5, "cm"),
-                          width_footnotes = grid::unit(1, "npc") - grid::unit(1.5, "cm"),
+                          width_titles = grid::unit(1, "npc"),
+                          width_footnotes = grid::unit(1, "npc"),
                           border = TRUE,
-                          margins = grid::unit(c(1, 0, 1, 0), "lines"),
                           padding = grid::unit(rep(1, 4), "lines"),
+                          margins = grid::unit(c(1, 0, 1, 0), "lines"),
                           outer_margins = grid::unit(c(2, 1.5, 3, 1.5), "cm"),
                           gp_titles = grid::gpar(),
                           gp_footnotes = grid::gpar(fontsize = 8),
                           name = NULL,
                           gp = grid::gpar(),
                           vp = NULL) {
+  # External margins need to be taken into account when defining the width of titles and footers
+  # because the text is split in advance depending on only the width of the viewport.
+  if (any(as.numeric(outer_margins) > 0)) {
+    width_titles <- width_titles - outer_margins[4]
+    width_footnotes <- width_footnotes - outer_margins[4]
+  }
+
   st_titles <- split_text_grob(
     titles,
     x = 0, y = 1,
@@ -169,45 +184,45 @@ decorate_grob <- function(grob,
     gp = gp_footnotes
   )
 
+  # Initial decoration of the grob -> border, paddings, and margins are used here
+  main_plot <- grid::gTree(
+    children = grid::gList(
+      if (border) grid::rectGrob(),
+      grid::gTree(
+        children = grid::gList(
+          grob
+        ),
+        vp = grid::plotViewport(margins = padding) # innermost margins of the grob plot
+      )
+    ),
+    vp = grid::vpStack(
+      grid::viewport(layout.pos.row = 2, layout.pos.col = 1),
+      grid::plotViewport(margins = margins) # margins around the border plot
+    )
+  )
+
   grid::gTree(
     grob = grob,
     titles = titles,
     footnotes = footnotes,
     page = page,
     width_titles = width_titles,
     width_footnotes = width_footnotes,
-    border = border,
-    margins = margins,
-    padding = padding,
     outer_margins = outer_margins,
     gp_titles = gp_titles,
     gp_footnotes = gp_footnotes,
     children = grid::gList(
       grid::gTree(
         children = grid::gList(
           st_titles,
-          grid::gTree(
-            children = grid::gList(
-              if (border) grid::rectGrob(),
-              grid::gTree(
-                children = grid::gList(
-                  grob
-                ),
-                vp = grid::plotViewport(margins = padding)
-              )
-            ),
-            vp = grid::vpStack(
-              grid::viewport(layout.pos.row = 2, layout.pos.col = 1),
-              grid::plotViewport(margins = margins)
-            )
-          ),
+          main_plot, # main plot with border, padding, and margins
           st_footnotes,
           pg_footnote
         ),
         childrenvp = NULL,
         name = "titles_grob_footnotes",
         vp = grid::vpStack(
-          grid::plotViewport(margins = outer_margins),
+          grid::plotViewport(margins = outer_margins), # Main external margins
           grid::viewport(
             layout = grid::grid.layout(
               nrow = 4, ncol = 1,
@@ -385,6 +400,7 @@ split_string <- function(text, width) {
     if (length(newline_str) > 1) {
       for (i in seq(2, length(newline_str))) {
         width_i <- grid::stringWidth(newline_str[i])
+        # Main conversion of allowed text width -> npc units are 0<npc<1. External viewport is used for conversion
         if (grid::convertWidth(linewidth + gapwidth + width_i, grid::unitType(width), valueOnly = TRUE) < availwidth) {
           sep <- " "
           linewidth <- linewidth + gapwidth + width_i

inst/WORDLIST

@@ -7,6 +7,8 @@ ADTTE
 AE
 ANCOVA
 Agresti
+Anova
+Bové
 Byar's
 CDISC
 CMH
@@ -26,6 +28,7 @@ Newcombe
 Pre
 Rua
 SMQ
+Sabanés
 Satterthwaite
 Schouten
 TLG
@@ -38,11 +41,13 @@ coercible
 de
 funder
 layouting
+params
 pharmacokinetic
 pre
 repo
 responder
 responders
+rtables
 subtable
 subtables
 unformatted