Package 'fgeo'

Title: Analyze Forest Diversity and Dynamics
Description: To help you access, transform, analyze, and visualize ForestGEO data, we developed a collection of R packages (<https://forestgeo.github.io/fgeo/>). This package, in particular, helps you to install and load the entire package-collection with a single R command, and provides convenient ways to find relevant documentation. Most commonly, you should not worry about the individual packages that make up the package-collection as you can access all features via this package. To learn more about ForestGEO visit <http://www.forestgeo.si.edu/>.
Authors: Mauro Lepore [aut, ctr, cre] , Gabriel Arellano [aut, rev], Richard Condit [aut], Stuart Davies [aut, rev], Matteo Detto [aut], Erika Gonzalez-Akre [aut, rev] , Pamela Hall [aut], Kyle Harms [aut], Valentine Herrmann [aut, rev] , Aaron Hogan [rev] , Bier Kraichak [rev], David Kenfack [aut, rev], Lauren Krizel [rev], Suzanne Lao [aut, rev], Sean McMahon [aut, rev], Haley Overstreet [rev], Sabrina Russo [aut, rev], Cara Scalpone [rev] , Kristina Anderson-Teixeira [aut, rev], Graham Zemunik [aut, rev], Daniel Zuleta [aut, rev], CTFS-ForestGEO [cph, fnd]
Maintainer: Mauro Lepore <[email protected]>
License: GPL-3
Version: 1.1.4.9000
Built: 2024-11-20 03:20:09 UTC
Source: https://github.com/forestgeo/fgeo

Help Index

Open a web browser on fgeo's website.

Description

Load fgeo's URLs into an HTML browser.

Usage

fgeo_browse()

fgeo_browse_reference()

See Also

Other functions to explore fgeo: fgeo_help, fgeo_packages

Examples

if (interactive()) {
  fgeo_browse()
  fgeo_browse_reference()
}

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")
}

Names of the core fgeo packages.

Description

Names of the core fgeo packages.

Usage

fgeo_packages(include_self = TRUE)

Arguments

include_self

Logical. Should the output include fgeo?

Value

A string.

See Also

Other functions to explore fgeo: fgeo_browse, fgeo_help

Examples

fgeo_packages()
fgeo_packages(include_self = FALSE)