check_single_augment_output

Call this function to perform tests. If a tests fails, an informative error
will be thrown. Otherwise silent.
Test when <code>strict = FALSE</code>:<ul>
<li><code>au</code> passes <code>check_tibble()</code>.</li>
<li>All column names present in <code>passed_data</code> are also present in <code>au</code>.</li>
</ul>Additional tests when <code>strict = TRUE</code>:<ul>
<li>If <code>passed_data</code> has rownames other than simple row numbers (i.e. <code>paste(1:5)</code>),
<code>au</code> contains a column called <code>.rownames</code>.</li>
</ul>

internal

Provides a number of testthat tests that can be
used to verify that tidy(), glance() and augment() methods meet
consistent specifications. This allows methods for the same generic to
be spread across multiple packages, since all of those packages can
make the same guarantees to users about returned objects.

Alex Hayes

modeltests

Testing Infrastructure for Broom Model Generics

Simon Couch

check_single_augment_output function

<dl><dt>au</dt>
<dd>Output from a call to <code><a href="https://broom.tidymodels.org/reference/reexports.html">broom::augment()</a></code>.</dd>
<dt>passed_data</dt>
<dd>Whichever of <code>data</code> or <code>newdata</code> was passed to
<code>augment</code>. Should be a data frame or tibble.</dd>
<dt>strict</dt>
<dd>Logical indicating whether the strict version of tests should be used. Defaults
to <code>TRUE</code>.</dd></dl>

Arguments

Call this function to perform tests. If a tests fails, an informative error
will be thrown. Otherwise silent.
Test when <code>strict = FALSE</code>:<ul>
<li><code>au</code> passes <code>check_tibble()</code>.</li>
<li>All column names present in <code>passed_data</code> are also present in <code>au</code>.</li>
</ul>

Additional tests when <code>strict = TRUE</code>:<ul>
<li>If <code>passed_data</code> has rownames other than simple row numbers (i.e. <code>paste(1:5)</code>),
<code>au</code> contains a column called <code>.rownames</code>.</li>
</ul>

Check the output of an augment method — check_single_augment_output

<dl>

<dt>au</dt>
<dd>Output from a call to <code><a href='https://broom.tidymodels.org/reference/reexports.html'>broom::augment()</a></code>.</dd>


<dt>passed_data</dt>
<dd>Whichever of <code>data</code> or <code>newdata</code> was passed to
<code>augment</code>. Should be a data frame or tibble.</dd>


<dt>strict</dt>
<dd>Logical indicating whether the strict version of tests should be used. Defaults
to <code>TRUE</code>.</dd>

</dl>

check_single_augment_output: Check the output of an augment method

Description

Usage

Value

Arguments