release 0.7.4

Author: Polkas

.Rbuildignore

@@ -11,6 +11,5 @@
 ^\.github$
 ^\.devcontainer$
 ^Rplots\.pdf$
-
 ^doc$
 ^Meta$

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: gridify
 Title: Enrich Figures and Tables with Custom Headers and Footers and More
-Version: 0.7.3
+Version: 0.7.4
 Authors@R: c(
     person("Maciej", "Nasinski", , "Maciej.Nasinski@ucb.com", role = c("aut", "cre")),
     person("Alexandra", "Wall", , "Alexandra.Wall@ucb.com", role = "aut"),
@@ -17,7 +17,8 @@ Authors@R: c(
   )
 Description: A simple and flexible tool designed to create enriched figures and tables by providing a way to add text 
     around them through predefined or custom layouts. 
-    Any input which is convertible to 'grob' is supported, like 'ggplot', 'gt' or 'flextable'.
+    Any input which is convertible to 'grob' is supported, like 'ggplot', 'gt' or 'flextable'. 
+    Based on R 'grid' graphics, for more details see Paul Murrell (2018) <doi:10.1201/9780429422768>.
 License: Apache License 2.0
 URL: https://pharmaverse.github.io/gridify/
 BugReports: https://github.com/pharmaverse/gridify/issues

NEWS.md

@@ -1,3 +1,8 @@
+# gridify 0.7.4
+
+* Updated `export_to` method examples to not use `dontrun`.
+* Added doi in the DESCRIPTION file.
+
 # gridify 0.7.3
 
 * Improved `show_spec` method for `gridifyLayout`.

R/gridify-methods.R

@@ -170,10 +170,7 @@ setMethod(
       stop("The text argument is not a character string.")
     }
 
-    if (
-      !(is.null(mch) ||
-        (inherits(mch, "numeric") && length(mch) == 1) && mch > 0)
-    ) {
+    if (!(is.null(mch) || (inherits(mch, "numeric") && length(mch) == 1) && mch > 0)) {
       stop("The mch argument is not a positive numeric value.")
     }
 
@@ -1007,40 +1004,116 @@ setMethod("show", "gridifyLayout", function(object) {
 #'   set_cell("footer_right", "Page xx of nn") %>%
 #'   set_cell("watermark", "DRAFT")
 #'
-#' \dontrun{
-#' export_to(gridify_obj, to = "output.png")
-#' export_to(gridify_obj, to = "output.png", width = 2400, height = 1800, res = 300)
+#' # Export a result to different file types
+#'
+#' # Different file export formats require specific capabilities in your R installation.
+#' # Use capabilities() to check which formats are supported in your R build.
 #'
-#' export_to(gridify_obj, to = "output.jpeg")
-#' export_to(gridify_obj, to = "output.jpeg", width = 2400, height = 1800, res = 300)
+#' # PNG
+#' temp_png_default <- tempfile(fileext = ".png")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_png_default
+#' )
 #'
-#' export_to(gridify_obj, to = "output.tiff")
-#' export_to(gridify_obj, to = "output.tiff", width = 2400, height = 1800, res = 300)
+#' temp_png_custom <- tempfile(fileext = ".png")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_png_custom,
+#'   width = 2400,
+#'   height = 1800,
+#'   res = 300
+#' )
 #'
-#' export_to(gridify_obj, to = "outputA4.pdf")
-#' export_to(gridify_obj, to = "outputA4long.pdf", width = 8.3, height = 11.7)
+#' # JPEG
+#' temp_jpeg_default <- tempfile(fileext = ".jpeg")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_jpeg_default
+#' )
 #'
-#' # Use different pdf device
+#' temp_jpeg_custom <- tempfile(fileext = ".jpeg")
 #' export_to(
 #'   gridify_obj,
-#'   to = "outputA4long.pdf", device = grDevices::cairo_pdf, width = 8.3, height = 11.7
+#'   to = temp_jpeg_custom,
+#'   width = 2400,
+#'   height = 1800,
+#'   res = 300
 #' )
 #'
+#' # TIFF
+#' temp_tiff_default <- tempfile(fileext = ".tiff")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_tiff_default
+#' )
+#'
+#' temp_tiff_custom <- tempfile(fileext = ".tiff")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_tiff_custom,
+#'   width = 2400,
+#'   height = 1800,
+#'   res = 300
+#' )
+#'
+#' # PDF
+#' temp_pdf_A4 <- tempfile(fileext = ".pdf")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_pdf_A4
+#' )
+#'
+#' temp_pdf_A4long <- tempfile(fileext = ".pdf")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_pdf_A4long,
+#'   width = 8.3,
+#'   height = 11.7
+#' )
+#'
+#' # Use different pdf device - cairo_pdf
+#' temp_pdf_A4long_cairo <- tempfile(fileext = ".pdf")
+#' export_to(
+#'   gridify_obj,
+#'   to = temp_pdf_A4long_cairo,
+#'   device = grDevices::cairo_pdf,
+#'   width = 8.3,
+#'   height = 11.7
+#' )
+#'
+#' # Multiple Objects - a list
+#'
 #' gridify_list <- list(gridify_obj, gridify_obj)
 #'
-#' export_to(gridify_list, to = "multipageA4.pdf")
-#' export_to(gridify_list, to = "multipageA4long.pdf", width = 8.3, height = 11.7)
-#' export_to(gridify_list, to = "multipageA4long.pdf", width = 8.3, height = 11.7)
+#' temp_pdf_multipageA4 <- tempfile(fileext = ".pdf")
+#' export_to(
+#'   gridify_list,
+#'   to = temp_pdf_multipageA4
+#' )
+#'
+#' temp_pdf_multipageA4long <- tempfile(fileext = ".pdf")
+#' export_to(
+#'   gridify_list,
+#'   to = temp_pdf_multipageA4long,
+#'   width = 8.3,
+#'   height = 11.7
+#' )
 #'
-#' export_to(gridify_list, to = c("page1.png", "page2.png"))
+#' temp_png_multi <- c(tempfile(fileext = ".png"), tempfile(fileext = ".png"))
 #' export_to(
 #'   gridify_list,
-#'   to = c("page1_96res.png", "page2_96res.png"),
+#'   to = temp_png_multi
+#' )
+#'
+#' temp_png_multi_custom <- c(tempfile(fileext = ".png"), tempfile(fileext = ".png"))
+#' export_to(
+#'   gridify_list,
+#'   to = temp_png_multi_custom,
 #'   width = 800,
 #'   height = 600,
 #'   res = 96
 #' )
-#' }
 #'
 #' @export
 setGeneric("export_to", function(x, to, device = NULL, ...) {

inst/WORDLIST

@@ -5,11 +5,13 @@ centers
 CMD
 Codecov
 Dallimore
+doi
 HersheySerif
 Laetitia
 Lemoine
 McShea
 Montironi
+Murrell
 Ncol
 Nrow
 PatientID

man/export_to.Rd

@@ -462,10 +462,11 @@ The `background` argument works across all built-in layout functions, including
 
 ```{r}
 figure_obj <- ggplot2::ggplot(data = mtcars, ggplot2::aes(x = mpg, y = wt)) +
-   ggplot2::theme(
+  ggplot2::theme(
     plot.background = ggplot2::element_rect(fill = "beige", colour = NA),  # Entire plot background
     panel.background = ggplot2::element_rect(fill = "beige", colour = NA),     # Panel (where data is plotted)
-    panel.border = ggplot2::element_rect(colour = "black", fill = NA)) +
+    panel.border = ggplot2::element_rect(colour = "black", fill = NA)
+  ) +
   ggplot2::geom_line()
 
 g <- gridify(figure_obj, layout = simple_layout(background = "beige")) %>%