test_examples

test_rd

test_example

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.

internal

Software testing is important, but, in part because it is
frustrating and boring, many of us avoid it. 'testthat' is a testing
framework for R that is easy to learn and use, and integrates with
your existing 'workflow'.

Hadley Wickham

testthat

Unit Testing for R

Posit Software, PBC 

R Core team 

test_examples function

<dl><dt>path</dt>
<dd>For <code>test_examples()</code>, path to directory containing Rd files.
For <code>test_example()</code>, path to a single Rd file. Remember the working
directory for tests is <code>tests/testthat</code>.</dd>
<dt>rd</dt>
<dd>A parsed Rd object, obtained from <code><a href="/link/tools%3A%3ARd_db()?package=testthat&version=3.2.1.1" data-mini-rdoc="testthat::tools::Rd_db()">tools::Rd_db()</a></code> or otherwise.</dd>
<dt>title</dt>
<dd>Test title to use</dd></dl>

Arguments

Test package examples — test_examples

<dl>

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


<dt>rd</dt>
<dd>A parsed Rd object, obtained from <code><a href='https://rdrr.io/r/tools/Rdutils.html'>tools::Rd_db()</a></code> or otherwise.</dd>


<dt>title</dt>
<dd>Test title to use</dd>

</dl>

test_examples: Test package examples

Description

Usage

Arguments