Package 'dverse'

Title: Document a Universe of Packages
Description: 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.
Authors: Mauro Lepore [aut, cre, cph]
Maintainer: Mauro Lepore <[email protected]>
License: MIT + file LICENSE
Version: 0.1.0
Built: 2024-11-25 14:59:07 UTC
Source: CRAN

Help Index

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

Description

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.

Usage

document_universe(x, url_template = NULL)

Arguments

x

A character vector giving concepts or package names to match.
url_template

Character. A template to generate links to documentation based on the column names of the output – typically package and topic, e.g. "https://maurolepore.github.io/{package}/reference/{topic}.html" (glue::glue() syntax).

Value

A data frame.

Examples

library(glue)
library(tibble)

url_template <- "https://{package}.tidyverse.org/reference/{topic}.html"
document_universe(c("glue", "tibble"), url_template)