fgeo_help {fgeo}

Get help with fgeo.

Description

fgeo_help() finds all fgeo help files. You can refine your search directly on the viewer panel of RStudio or via a string passed as the first argument to fgeo_help().

Usage

fgeo_help(pattern = "", package = NULL, rebuild = TRUE, ...)

Arguments

pattern

A character string to be matched in the name, alias or title of a topic's documentation. Defaults to matching everything, which retrieves all the documentation of fgeo packages.

package

A character string giving the name of one or more packages to limit the search, or NULL to search all fgeo packages.

rebuild

a logical indicating whether the help database should be rebuilt. This will be done automatically if lib.loc or the search path is changed, or if package is used and a value is not found.

...

Other arguments passed to utils::help.search().

Value

The results are returned in a list object of class "hsearch", which has a print method for nicely formatting the results of the query.

See Also

utils::help.search().

Other functions to explore fgeo: fgeo_browse, fgeo_packages

Examples

if (interactive()) {
  fgeo_help()
}

dplyr::as_tibble(fgeo_help()$matches)

if (interactive()) {
  fgeo_help("stem", package = "fgeo.x")
}