| Title: | Document a Universe of Packages |
| Version: | 0.2.0 |
| 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. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/maurolepore/dverse, https://maurolepore.github.io/dverse/ |
| BugReports: | https://github.com/maurolepore/dverse/issues |
| Depends: | R (≥ 3.6) |
| Imports: | cli, curl, dplyr, glue, rlang, tibble, utils |
| Suggests: | DT, knitr, testthat, withr |
| Config/Needs/website: | rmarkdown |
| Config/testthat/edition: | 3 |
| Encoding: | UTF-8 |
| Language: | en-US |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2024-12-07 23:56:05 UTC; rstudio |
| Author: | Mauro Lepore 
[aut, cre, cph] |
| Maintainer: | Mauro Lepore <maurolepore@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2024-12-08 00:20:02 UTC |
dverse: 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.
Author(s)
Maintainer: Mauro Lepore maurolepore@gmail.com (ORCID) [copyright holder]
See Also
Useful links:
Report bugs at https://github.com/maurolepore/dverse/issues
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 |
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)
Is each URL (or href) online?
Description
Is each URL (or href) online?
Usage
is_online(x)
Arguments
x |
String. |
Value
A logical vector.
Examples
url <- c(
"https://example.com",
"<a href=https://example.com>example</a>",
"<a href=https://example.com/bad>bad</a>",
"bad"
)
is_online(url)