document_universe

Create a data.frame with documentation metadata of one or more packages. If
you develop a universe, such as the tidyverse or tidymodels, dverse helps you
to easily create a universe-wide reference for the pkgdown website of your
meta-package.

Creates a data frame containing the metadata associated with
the documentation of a collection of R packages. It allows for linking
topic names to their corresponding documentation online. If you
maintain a universe meta-package, it helps create a comprehensive
reference for its website.

Mauro Lepore

dverse

Document a Universe of Packages

document_universe function

<dl><dt>x</dt>
<dd>A character vector giving concepts or package names to match.</dd>
<dt>url_template</dt>
<dd>Character. A template to generate links to documentation
based on the column names of the output -- typically <code>package</code> and <code>topic</code>,
e.g. <code>"https://maurolepore.github.io/{package}/reference/{topic}.html"</code>
(<code><a href="https://glue.tidyverse.org/reference/glue.html">glue::glue()</a></code> syntax).</dd></dl>

Arguments

Create a data frame with documentation metadata of one or more packages — document_universe

<dl>

<dt>x</dt>
<dd>A character vector giving concepts or package names to match.</dd>


<dt>url_template</dt>
<dd>Character. A template to generate links to documentation
based on the column names of the output -- typically <code>package</code> and <code>topic</code>,
e.g. <code>"https://maurolepore.github.io/{package}/reference/{topic}.html"</code>
(<code><a href='https://glue.tidyverse.org/reference/glue.html'>glue::glue()</a></code> syntax).</dd>

</dl>

document_universe: Create a data frame with documentation metadata of one or more packages

Description

Usage

Value

Arguments

Examples