reference_package: Pick documentation matching some concepts or package names.

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

Pick documentation matching some concepts or package names.

Description

These functions help you to reference the documentation of specific functions across multiple packages. This is useful in meta-packages. * The functions ending in package output all exported objects of the given packages, and the functions ending in concept output all objects containing the given concepts (strings passed to @family).

• The functions starting with reference_ output a dataframe optimized for building a reference table (maybe with DT::datatable() or knitr::kable()).

Usage

reference_package(x, url = NULL, packages = NULL,
  strip_s3class = TRUE)

reference_concept(x, url = NULL, packages = NULL,
  strip_s3class = TRUE)

Arguments

x	A character vector giving concepts or package names to match.
url	Character vector of length-1 giving a base url, e.g. "https://forestgeo.github.io/".
packages	A character vector with the names of packages to limit the search, or NULL to serach in all known libraries.
strip_s3class	TRUE removes the class component of S3 methods.

Value

A dataframe.

See Also

Other retrieve documentation: search_docs

Examples

## Not run: 
if (requireNamespace("fgeo.x", quietly = TRUE)) {
  library(fgeo.x)

  reference_concept("datasets", url = "https://forestgeo.github.io/")
  reference_package("datasets", url = "https://forestgeo.github.io/")
}

## End(Not run)

maurolepore/pkgdoc documentation built on Nov. 4, 2024, 6:56 a.m.