change examplesIf to dontrun

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
 Version: 0.1.0
-Date: 2024-08-21 21:42:06 UTC
-SHA: 511abcf63ad8520b01e2a4f408eaad8df1918572
+Date: 2024-08-23 19:56:50 UTC
+SHA: 1d388bf328cb6c3d6f396aac4d64ede4d4f6eb34

R/render.R

@@ -8,8 +8,10 @@
 #' @return A modified `word_document2` with the standard topic guide formatting.
 #' @export
 #'
-#' @examplesIf interactive()
-#'   output: ratlas::topicguide_docx
+#' @examples
+#' \dontrun{
+#' output: ratlas::topicguide_docx
+#' }
 topicguide_docx <- function(...) {
   template <- find_resource("topicguide_docx", "template.docx")
   base <- bookdown::word_document2(reference_docx = template, ...)
@@ -43,8 +45,10 @@ topicguide_docx <- function(...) {
 #' @return A modified `word_document2` with the standard topic guide formatting.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::topicguide_rdocx
+#' }
 topicguide_rdocx <- function(...) {
   template <- find_resource("topicguide_rdocx", "template.docx")
   base <- officedown::rdocx_document(base_format = "bookdown::word_document2",
@@ -106,8 +110,10 @@ topicguide_rdocx <- function(...) {
 #' @return A modified `pdf_document2` with the standard tech report formatting.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::topicguide_pdf
+#' }
 topicguide_pdf <- function(...) {
   topic_guide_template <- find_resource("topicguide_pdf", "template.tex")
   base <- bookdown::pdf_document2(template = topic_guide_template,
@@ -150,8 +156,10 @@ topicguide_pdf <- function(...) {
 #' @return A modified `pdf_document2` with the standard tech report formatting.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::measr_pdf
+#' }
 measr_pdf <- function(...) {
   report_template <- find_resource("measr_pdf", "template.tex")
   base <- bookdown::pdf_document2(template = report_template,
@@ -196,8 +204,10 @@ measr_pdf <- function(...) {
 #' @return A modified `pdf_document2` with the standard tech report formatting.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::techreport_pdf
+#' }
 techreport_pdf <- function(apa6 = FALSE, ...) {
   template_name <- ifelse(apa6, "apa6-template.tex", "template.tex")
   tech_report_template <- find_resource("techreport", template_name)
@@ -245,8 +255,10 @@ techreport_pdf <- function(apa6 = FALSE, ...) {
 #' @return A modified `gitbook` with the standard tech report formatting.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::techreport_gitbook
+#' }
 techreport_gitbook <- function(...) {
   base <-
     bookdown::gitbook(css = "assets/style.css",
@@ -306,8 +318,10 @@ techreport_gitbook <- function(...) {
 #' @return A modified `mood_reader` with ATLAS branding applied.
 #' @export
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' output: ratlas::slides_html
+#' }
 slides_html <- function(...) {
   default_nature <- list(ratio = "16:9",
                          highlightStyle = "github",

R/save-plot.R

@@ -16,12 +16,14 @@
 #'   `v` for vertical.
 #' @param embed_fonts Logical. Use Ghostscript to embed fonts in a PDF graphic?
 #' @param ... Additional arguments passed to [ggplot2::ggsave()]
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' p <- ggplot(mtcars, aes(mpg, wt)) +
 #'  geom_point()
 #'
 #' ggsave2(p, "/mtcars.pdf", path = tempdir())
 #' ggsave2(p, "/mtcars.png", path = tempdir())
+#' }
 #' @return None. Called for side effects.
 #' @export
 ggsave2 <- function(plot = ggplot2::last_plot(), filename, device = NULL,

R/set-theme.R

@@ -13,8 +13,10 @@
 #'   "inferno", "plasma", "viridis" (default), or "cividis", or "ggplot2".
 #' @param ... Additional arguments to pass to theme functions.
 #'
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' set_theme("Arial Narrow")
+#' }
 #' @return None. Called for side effects.
 #' @export
 set_theme <- function(font = "Arial Narrow",

R/theme-atlas.R

@@ -24,7 +24,8 @@
 #' @param ticks ticks if `TRUE` add ticks
 #' @return A theme for use in plots created with [ggplot2::ggplot()].
 #' @export
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' library(ggplot2)
 #' library(dplyr)
 #'
@@ -51,6 +52,7 @@
 #'        caption = "Brought to you by the letter 'g'") +
 #'   theme_atlas(grid = "Y") +
 #'   theme(axis.text.y = element_blank())
+#'   }
 theme_atlas <- function(base_family = "Arial Narrow", base_size = 11.5,
                         plot_title_family = base_family,
                         plot_title_size = 18,

R/utils.R

@@ -4,9 +4,10 @@
 #' @param sep a separator for each line.
 #'
 #' @return a string
-#' @examplesIf interactive()
+#' @examples
+#' \dontrun{
 #' inc("front-matter/preface.Rmd")
-#'
+#' }
 #' @export
 inc <- function(input, sep = "\n\n  ") {
   paste(readLines(input), collapse = sep)