test_examples: Test package examples

Description Usage Arguments

View source: R/test-example.R

Description

These helper functions make it easier to test the examples in a package. Each example counts as one test, and it succeeds if the code runs without an error. Generally, this is redundant with R CMD check, and is not recommended in routine practice.

Usage

1
2
3
4
5
test_examples(path = "../..")

test_rd(rd, title = attr(rd, "Rdfile"))

test_example(path, title = path)

Arguments

path

For test_examples(), path to directory containing Rd files. For test_example(), path to a single Rd file. Remember the working directory for tests is tests/testthat.

rd

A parsed Rd object, obtained from tools::Rd_db() or otherwise.

title

Test title to use


testthat documentation built on Oct. 4, 2021, 9:07 a.m.