rgrassdoc (version 1.0.0)

man: View a 'GRASS GIS' module manual page

Description

Visualize a 'GRASS GIS' module manual page either in the RStudio viewer pane or in your browser.

Usage

man(module, viewer = .Options$grass.viewer, dir = tempdir())
browse(module, viewer = "browser", dir = tempdir())

Arguments

module

(Character string, or simply the name of a 'GRASS GIS' module) The function supports non standard evaluation (i.e. man(r.in.gdal)).

viewer

(Character string) One of "viewer" or "browser". The viewer in which to disply the documentation, default to .Options$grass.viewer (i.e. the 'Rstudio' pane). browse is a wrapper around man with de default viewer set to the browser.

dir

(Character string) The directory in which to store the cached documentation (default to tempdir()).

Value

This function does not return anything and is used for its side effects.

Examples

# NOT RUN {
man("r.in.gdal")
browse(r.reclass)
# }
# NOT RUN {
# }