use_tibble

<a href="https://lifecycle.r-lib.org/articles/stages.html#questioning"><img src="figures/lifecycle-questioning.svg?package=usethis&version=3.0.0" alt="[Questioning]"></a>
Does minimum setup such that a tibble returned by your package
is handled using the tibble method for generics like <code><a href="/link/print()?package=usethis&version=3.0.0" data-mini-rdoc="usethis::print()">print()</a></code> or <code>[</code>.
Presumably you care about this if you've chosen to store and expose an
object with class <code>tbl_df</code>. Specifically:<ul>
<li>Check that the active package uses roxygen2</li>
<li>Add the tibble package to "Imports" in <code>DESCRIPTION</code></li>
<li>Prepare the roxygen directive necessary to import at least one function
from tibble:<ul>
<li>If possible, the directive is inserted into existing package-level
documentation, i.e. the roxygen snippet created by <code>use_package_doc()</code></li>
<li>Otherwise, we issue advice on where the user should add the directive</li>
</ul></li>
</ul>This is necessary when your package returns a stored data object that has
class <code>tbl_df</code>, but the package code does not make direct use of functions
from the tibble package. If you do nothing, the tibble namespace is not
necessarily loaded and your tibble may therefore be printed and subsetted
like a base <code>data.frame</code>.

Automate package and project setup tasks that are otherwise
performed manually. This includes setting up unit testing, test
coverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp',
'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

Malcolm Barrett

Andy Teucher

Posit Software, PBC 

use_tibble function

<a href='https://lifecycle.r-lib.org/articles/stages.html#questioning'><img src='figures/lifecycle-questioning.svg' alt='[Questioning]' /></a>
Does minimum setup such that a tibble returned by your package
is handled using the tibble method for generics like <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code> or <code>[</code>.
Presumably you care about this if you've chosen to store and expose an
object with class <code>tbl_df</code>. Specifically:<ul>
<li>Check that the active package uses roxygen2</li>
<li>Add the tibble package to "Imports" in <code>DESCRIPTION</code></li>
<li>Prepare the roxygen directive necessary to import at least one function
from tibble:<ul>
<li>If possible, the directive is inserted into existing package-level
documentation, i.e. the roxygen snippet created by <code>use_package_doc()</code></li>
<li>Otherwise, we issue advice on where the user should add the directive</li>
</ul></li>
</ul>

This is necessary when your package returns a stored data object that has
class <code>tbl_df</code>, but the package code does not make direct use of functions
from the tibble package. If you do nothing, the tibble namespace is not
necessarily loaded and your tibble may therefore be printed and subsetted
like a base <code>data.frame</code>.

use_tibble: Prepare to return a tibble

Description

Usage

Arguments

Examples