In doctest: Generate Tests from Examples Using 'roxygen' and 'testthat'

Example

Here's some roxygen documentation for a function:

```r
rox <- r"--[
#' Fibonacci function 
#' 
#' @param n Integer
#' @return The nth Fibonacci number
#' 
#' @doctest
#'
#' @expect type("integer")
#' fib(2)
#'
#' n <- 6 
#' @expect equal(8)
#' fib(n)
#' 
#' @expect warning("not numeric")
#' fib("a")
#'
#' @expect warning("NA")
#' fib(NA)
fib <- function (n) {
  if (! is.numeric(n)) warning("n is not numeric")
  ...
}
]--"
cat(rox)

Instead of an `@examples` section, we have a `@doctest` section.

This will create tests like:

```r
library(doctest)
library(roxygen2)
results <- roc_proc_text(dt_roclet(), rox)
roclet_output(dt_roclet(), results)

The .Rd file will be created as normal, with an example section like:

results <- roc_proc_text(rd_roclet(), rox)
text <- format(results[[1]])
cat(gsub(".*\\\\examples", "\\\\examples", text))

doctest documentation built on May 29, 2024, 7:09 a.m.