169 wrapping up the long code in the Report

R/DownloadModule.R

@@ -33,9 +33,17 @@ download_report_button_ui <- function(id) {
 #' For more details see the vignette: `vignette("simpleReporter", "teal.reporter")`.
 #' @param id `character(1)` this `shiny` module's id.
 #' @param reporter [`Reporter`] instance.
-#' @param global_knitr `list` a global `knitr` parameters for customizing the rendering process.
+#' @param global_knitr `list` a of `knitr` parameters (passed to `knitr::opts_chunk$set`)
+#'  for customizing the rendering process.
 #' @inheritParams reporter_download_inputs
 #' @return `shiny::moduleServer`
+#' @details To access the default values for the `global_knitr` parameter,
+#'  use `getOption("teal.reporter.global_knitr")`.These defaults include:
+#' - `echo`: `TRUE`
+#' - `tidy.opts`: `list(width.cutoff = 60)`
+#' - `tidy`: This option is automatically set to `TRUE` if the `formatR` package is present in the namespace;
+#'  otherwise, it is set to `FALSE`.
+#'
 #' @export
 download_report_button_srv <- function(id,
                                        reporter,

R/Previewer.R

@@ -31,8 +31,15 @@ reporter_previewer_ui <- function(id) {
 #' For more details see the vignette: `vignette("previewerReporter", "teal.reporter")`.
 #' @param id `character(1)` this `shiny` module's id.
 #' @param reporter `Reporter` instance
-#' @param global_knitr `list` a global `knitr` parameters for customizing the rendering process.
+#' @param global_knitr `list` a of `knitr` parameters (passed to `knitr::opts_chunk$set`)
+#'  for customizing the rendering process.
 #' @inheritParams reporter_download_inputs
+#' @details To access the default values for the `global_knitr` parameter,
+#'  use `getOption("teal.reporter.global_knitr")`.These defaults include:
+#' - `echo`: `TRUE`
+#' - `tidy.opts`: `list(width.cutoff = 60)`
+#' - `tidy`: This option is automatically set to `TRUE` if the `formatR` package is present in the namespace;
+#'  otherwise, it is set to `FALSE`.
 #' @export
 reporter_previewer_srv <- function(id,
                                    reporter,

R/Renderer.R

@@ -22,8 +22,15 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
     #' @description getting the `Rmd` text which could be easily rendered later.
     #'
     #' @param blocks `list` of `c("TextBlock", "PictureBlock", "NewpageBlock")` objects.
-    #' @param yaml_header `character` a `rmarkdown` `yaml` header.
-    #' @param global_knitr `list` a global `knitr` parameters for customizing the rendering process.
+    #' @param yaml_header `character` an `rmarkdown` `yaml` header.
+    #' @param global_knitr `list` a of `knitr` parameters (passed to `knitr::opts_chunk$set`)
+    #'  for customizing the rendering process.
+    #' @details To access the default values for the `global_knitr` parameter,
+    #'  use `getOption("teal.reporter.global_knitr")`.These defaults include:
+    #' - `echo`: `TRUE`
+    #' - `tidy.opts`: `list(width.cutoff = 60)`
+    #' - `tidy`: This option is automatically set to `TRUE` if the `formatR` package is present in the namespace;
+    #'  otherwise, it is set to `FALSE`.
     #'
     #' @return `character` a `Rmd` text (`yaml` header + body), ready to be rendered.
     renderRmd = function(blocks, yaml_header, global_knitr = getOption("teal.reporter.global_knitr")) {
@@ -84,8 +91,15 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
     #'
     #' @param blocks `list` of `c("TextBlock", "PictureBlock", "NewpageBlock")` objects.
     #' @param yaml_header `character` an `rmarkdown` `yaml` header.
-    #' @param global_knitr `list` a global `knitr` parameters for customizing the rendering process.
-    #' @param ... `rmarkdown::render` arguments, `input` and `output_dir` should not be updated.z
+    #' @param global_knitr `list` a of `knitr` parameters (passed to `knitr::opts_chunk$set`)
+    #'  for customizing the rendering process.
+    #' @param ... `rmarkdown::render` arguments, `input` and `output_dir` should not be updated.
+    #' @details To access the default values for the `global_knitr` parameter,
+    #'  use `getOption("teal.reporter.global_knitr")`.These defaults include:
+    #' - `echo`: `TRUE`
+    #' - `tidy.opts`: `list(width.cutoff = 60)`
+    #' - `tidy`: This option is automatically set to `TRUE` if the `formatR` package is present in the namespace;
+    #'  otherwise, it is set to `FALSE`.
     #'
     #' @return `character` path to the output
     render = function(blocks, yaml_header, global_knitr = getOption("teal.reporter.global_knitr"), ...) {

R/ReportCard.R

@@ -60,7 +60,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
       self$append_content(TextBlock$new(text, style))
       invisible(self)
     },
-    #' @description Appends a `rmarkdown` R chunk to this `ReportCard`.
+    #' @description Appends an `rmarkdown` R chunk to this `ReportCard`.
     #'
     #' @param text (`character(0)` or `character(1)`) the text
     #' @param ... any `rmarkdown` R chunk parameter and its value.

R/SimpleReporter.R

@@ -48,6 +48,13 @@ simple_reporter_ui <- function(id) {
 #' the function has a `card` argument and an optional `comment` argument.
 #' @param global_knitr `list` a global `knitr` parameters for customizing the rendering process.
 #' @inheritParams reporter_download_inputs
+#' @details To access the default values for the `global_knitr` parameter,
+#'  use `getOption("teal.reporter.global_knitr")`.These defaults include:
+#' - `echo`: `TRUE`
+#' - `tidy.opts`: `list(width.cutoff = 60)`
+#' - `tidy`: This option is automatically set to `TRUE` if the `formatR` package is present in the namespace;
+#'  otherwise, it is set to `FALSE`.
+#'
 #' @return `shiny::moduleServer`
 #' @export
 simple_reporter_srv <- function(id,