In maurolepore/pkgdoc: Reference Documented R Objects Across Multiple Packages

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

pkgdoc (deprecated)

See https://github.com/maurolepore/dverse

Dataframe the documentation of available packages, and reference objects across multiple packages by package or concept. Combined with krittr::kable() or DT::datatable(), pkgdoc allows you to reference functions by package or concept across multiple packages and to provide links to each topic's help file (similar to the Reference section of a pkgdown website but not limited to a single package).

Installation

# install.packages("devtools")
devtools::install_github("maurolepore/pkgdoc")

Example

library(pkgdoc)

search_docs() creates a dataframe of documentation available to you.

# Documentation of all installed packages
search_docs()

some_packages <- c("utils", "base")
search_docs(some_packages)

reference_package() and reference_concept() allow you to pick specific documentation.

reference_package(c("stats", "MASS"))

reference_concept(c("combine strings", "files", "PCA"))

Use knittr::kable() or DT::datatable() for the links to become clickable.

library(fgeo)

reference_concept(
  c("datasets", "plot functions"),
  url = "https://forestgeo.github.io/",
  ) %>% 
  arrange(concept) %>%
  head() %>% 
  knitr::kable()