expect

Previously, we recommended using <code>expect()</code> when writing your own
expectations. Now we instead recommend <code>pass()</code> and <code>fail()</code>. See
<code>vignette("custom-expectation")</code> for details.

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 

expect function

<dl><dt>ok</dt>
<dd><code>TRUE</code> or <code>FALSE</code> indicating if the expectation was successful.</dd>
<dt>failure_message</dt>
<dd>A character vector describing the failure. The
first element should describe the expected value, and the second (and
optionally subsequence) elements should describe what was actually seen.</dd>
<dt>info</dt>
<dd>Character vector continuing additional information. Included
for backward compatibility only and new expectations should not use it.</dd>
<dt>srcref</dt>
<dd>Location of the failure. Should only needed to be explicitly
supplied when you need to forward a srcref captured elsewhere.</dd>
<dt>trace</dt>
<dd>An optional backtrace created by <code><a href="https://rlang.r-lib.org/reference/trace_back.html">rlang::trace_back()</a></code>.
When supplied, the expectation is displayed with the backtrace.
Expert use only.</dd>
<dt>trace_env</dt>
<dd>If <code>trace</code> is not specified, this is used to generate an
informative traceback for failures. You should only need to set this if
you're calling <code>fail()</code> from a helper function; see
<code>vignette("custom-expectation")</code> for details.</dd></dl>

Arguments

The previous building block of all expect_ functions — expect

<dl>

<dt>ok</dt>
<dd><code>TRUE</code> or <code>FALSE</code> indicating if the expectation was successful.</dd>


<dt>failure_message</dt>
<dd>A character vector describing the failure. The
first element should describe the expected value, and the second (and
optionally subsequence) elements should describe what was actually seen.</dd>


<dt>info</dt>
<dd>Character vector continuing additional information. Included
for backward compatibility only and new expectations should not use it.</dd>


<dt>srcref</dt>
<dd>Location of the failure. Should only needed to be explicitly
supplied when you need to forward a srcref captured elsewhere.</dd>


<dt>trace</dt>
<dd>An optional backtrace created by <code><a href='https://rlang.r-lib.org/reference/trace_back.html'>rlang::trace_back()</a></code>.
When supplied, the expectation is displayed with the backtrace.
Expert use only.</dd>


<dt>trace_env</dt>
<dd>If <code>trace</code> is not specified, this is used to generate an
informative traceback for failures. You should only need to set this if
you're calling <code>fail()</code> from a helper function; see
<code>vignette("custom-expectation")</code> for details.</dd>

</dl>

expect: The previous building block of all `expect_` functions

Description

Usage

Value

Arguments

See Also