Package 'rgrassdoc'

GRASS 7.8 modules names and descriptions

Description

A dataset containing the names and descriptions of all GRASS 7.8 modules and addons, scraped from the GRASS manual full index page.

Usage

grassmodules78

Format

A data frame with 528 rows and 2 columns.

name

character, module name

description

character, module description

addon

logical, whether the module is an addon

Source

https://grass.osgeo.org/grass78/manuals/full_index.html https://grass.osgeo.org/grass78/manuals/addons/

---

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)

## End(Not run)

---

Access or modify the active GRASS doc version

Description

This set of function can be used to get the version used by the package or to set the desired version.

Usage

man_set_version(version = 7.8)

man_get_version()

Arguments

version

[Double] The desired version of GRASS (7.8, 7.9, etc...)

Value

The function 'man_get_version' will return the currently set version, and 'man_set_version' will do so invisibly.

Examples

man_set_version(7.9)
man_get_version()

---