R-CMD-check Lifecycle: experimental Codecov test coverage

Documentation examples and tests are similar in some ways:

This similarity makes it attractive to use “doctests”, which combine tests and documentation. Indeed, several languages, including Python and Rust, have doctests built in.[1] R also checks for errors in examples when running R CMD check.

The doctest package extends this idea. It lets you write testthat tests, by adding tags to your roxygen documentation. This helps you check that your examples do what they are supposed to do.


Here’s some roxygen documentation for a function:

#' 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")

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

This will create tests like:

# Generated by doctest: do not edit by hand
# Please edit file in R/<text>

test_that("Doctest: fib", {
  # Created from @doctest for `fib`
  # Source file: <text>
  # Source line: 7
  expect_type(fib(2), "integer")
  n <- 6
  expect_equal(fib(n), 8)
  expect_warning(fib("a"), "not numeric")
  expect_warning(fib(NA), "NA")

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


n <- 6 


You can install the development version of doctest like this:


To use doctest in your package, alter its DESCRIPTION file to add the dt_roclet roclet to roxygen:

Roxygen: list(roclets = c("collate", "rd", "namespace", 

Then use roxygen2::roxygenize() or devtools::document() to build your package documentation.

For more information, see the package vignette.