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().

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)
#> # A tibble: 329 x 9 #> Topic Title Name ID Package LibPath Type Field Entry #> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr> #> 1 abunda… Abundance a… abunda… 1/1 fgeo.a… /home/tra… help alias abundance #> 2 abunda… Abundance a… abunda… 1/1 fgeo.a… /home/tra… help alias basal_area #> 3 abunda… Abundance a… abunda… 1/1 fgeo.a… /home/tra… help conc… functions … #> 4 abunda… Abundance a… abunda… 1/1 fgeo.a… /home/tra… help Title Abundance … #> 5 abunda… Create tabl… abunda… 1/2 fgeo.a… /home/tra… help alias abundance_… #> 6 abunda… Create tabl… abunda… 1/2 fgeo.a… /home/tra… help alias basal_area… #> 7 abunda… Create tabl… abunda… 1/2 fgeo.a… /home/tra… help conc… functions … #> 8 abunda… Create tabl… abunda… 1/2 fgeo.a… /home/tra… help Title Create tab… #> 9 fgeo.a… fgeo.analyz… fgeo.a… 1/3 fgeo.a… /home/tra… help alias fgeo.analy… #> 10 fgeo.a… fgeo.analyz… fgeo.a… 1/3 fgeo.a… /home/tra… help alias fgeo.analy… #> # … with 319 more rows
if (interactive()) { fgeo_help("stem", package = "fgeo.x") }