inst/doc/writing_custom_examples.R

In admiraldev: Utility Functions and Development Tools for the Admiral Package Family

## ----setup, include = FALSE---------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

## ----eval = FALSE-------------------------------------------------------------
# #' @examplesx
# #'
# #' @caption Showcasing the first functionality of `fun()` (`arg1`)
# #'
# #' @info This is the detailed text for the first example.
# #'
# #' @code
# #'
# #' fun(arg1 = TRUE)
# #'
# #' @caption Showcasing the second functionality of `fun()` (`arg2`)
# #'
# #' @info This is the detailed text for the first example.
# #'
# #' @code
# #'
# #' fun(arg2 = FALSE)