use_package_doc

Adds a dummy <code>.R</code> file that will cause roxygen2 to generate basic
package-level documentation. If your package is named "foo", this will make
help available to the user via <code>?foo</code> or <code>package?foo</code>. Once you call
<code><a href="https://devtools.r-lib.org/reference/document.html">devtools::document()</a></code>, roxygen2 will flesh out the <code>.Rd</code> file using data
from the <code>DESCRIPTION</code>. That ensures you don't need to repeat (and remember
to update!) the same information in multiple places. This <code>.R</code> file is also a
good place for roxygen directives that apply to the whole package (vs. a
specific function), such as global namespace tags like <code>@importFrom</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_package_doc function

<dl><dt>open</dt>
<dd>Open the newly created file for editing? Happens in RStudio, if
applicable, or via <code><a href="/link/utils%3A%3Afile.edit()?package=usethis&version=3.1.0" data-mini-rdoc="usethis::utils::file.edit()">utils::file.edit()</a></code> otherwise.</dd></dl>

Arguments

Adds a dummy <code>.R</code> file that will cause roxygen2 to generate basic
package-level documentation. If your package is named "foo", this will make
help available to the user via <code>?foo</code> or <code>package?foo</code>. Once you call
<code><a href='https://devtools.r-lib.org/reference/document.html'>devtools::document()</a></code>, roxygen2 will flesh out the <code>.Rd</code> file using data
from the <code>DESCRIPTION</code>. That ensures you don't need to repeat (and remember
to update!) the same information in multiple places. This <code>.R</code> file is also a
good place for roxygen directives that apply to the whole package (vs. a
specific function), such as global namespace tags like <code>@importFrom</code>.

Package-level documentation — use_package_doc

<dl>

<dt>open</dt>
<dd>Open the newly created file for editing? Happens in RStudio, if
applicable, or via <code><a href='https://rdrr.io/r/utils/file.edit.html'>utils::file.edit()</a></code> otherwise.</dd>

</dl>

use_package_doc: Package-level documentation

Description

Usage

Arguments

See Also