Fix failed pipeline

.pre-commit-config.yaml

@@ -30,6 +30,8 @@ repos:
           - shinyWidgets
           - yaml
           - zip
+          - rlistings
+          - rtables
       - id: spell-check
         name: Check spelling with `spelling`
         exclude: >

DESCRIPTION

@@ -49,7 +49,8 @@ Suggests:
     tinytex,
     withr (>= 2.0.0)
 VignetteBuilder:
-    knitr
+    knitr,
+    rmarkdown
 RdMacros:
     lifecycle
 Config/Needs/verdepcheck: rstudio/bslib, mllg/checkmate,

R/PictureBlock.R

@@ -28,7 +28,7 @@ PictureBlock <- R6::R6Class( # nolint: object_name_linter.
     #' @param content (`ggplot` or `grob` or `trellis`) a picture in this `PictureBlock`
     #'
     #' @return `self`, invisibly.
-    #' @examples
+    #' @examplesIf require("ggplot2") && require("lattice")
     #' library(ggplot2)
     #' library(lattice)
     #'

R/Renderer.R

@@ -38,7 +38,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
     #' @details `r global_knitr_details()`
     #'
     #' @return Character vector constituting `rmarkdown` text (`yaml` header + body), ready to be rendered.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(yaml)
     #' library(rtables)
     #' library(ggplot2)
@@ -141,7 +141,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
     #' @details `r global_knitr_details()`
     #'
     #' @return `character` path to the output.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(yaml)
     #' library(ggplot2)
     #'

R/ReportCard.R

@@ -42,7 +42,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #' @param plot (`ggplot` or `grob` or `trellis`) plot object.
     #' @param dim (`numeric(2)`) width and height in pixels.
     #' @return `self`, invisibly.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #'
     #' card <- ReportCard$new()$append_plot(
@@ -132,7 +132,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #' @param key (`character(1)`) string specifying the metadata key.
     #' @param value value associated with the metadata key.
     #' @return `self`, invisibly.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #'
     #' card <- ReportCard$new()$append_text("Some text")$append_plot(
@@ -172,7 +172,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #' @description Convert the `ReportCard` to a list, including content and metadata.
     #' @param output_dir (`character`) with a path to the directory where files will be copied.
     #' @return (`named list`) a `ReportCard` representation.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #'
     #' card <- ReportCard$new()$append_text("Some text")$append_plot(
@@ -207,7 +207,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #' @param card (`named list`) a `ReportCard` representation.
     #' @param output_dir (`character`) with a path to the directory where a file will be copied.
     #' @return `self`, invisibly.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #'
     #' card <- ReportCard$new()$append_text("Some text")$append_plot(

R/Reporter.R

@@ -25,7 +25,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #'
     #' @param cards (`ReportCard`) or a list of such objects
     #' @return `self`, invisibly.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #' library(rtables)
     #'
@@ -57,7 +57,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' @description Retrieves all `ReportCard` objects contained in the `Reporter`.
     #'
     #' @return A (`list`) of [`ReportCard`] objects.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #' library(rtables)
     #'
@@ -89,7 +89,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' @param sep An optional separator to insert between each content block.
     #' Default is a `NewpageBlock$new()`object.
     #' @return `list()` list of `TableBlock`, `TextBlock`, `PictureBlock` and `NewpageBlock`.
-    #' @examples
+    #' @examplesIf require("ggplot2")
     #' library(ggplot2)
     #' library(rtables)
     #'