open_help: Access the QGIS/GRASS online help for a specific (Q)GIS...

Description Usage Arguments Details Value Note Author(s) Examples

View source: R/processing.R

Description

open_help opens the online help for a specific (Q)GIS geoalgorithm. This is the online help one also encounters in the QGIS GUI. In the case of GRASS algorithms this is actually the GRASS online documentation.

Usage

1
open_help(alg = "", qgis_env = set_env())

Arguments

alg

The name of the algorithm for which one wishes to retrieve arguments and default values.

qgis_env

Environment containing all the paths to run the QGIS API. For more information, refer to set_env().

Details

Bar a few exceptions open_help works for all QGIS, GRASS and SAGA geoalgorithms. The online help of other third-party providers, however, has not been tested so far.

Value

The function opens the default web browser, and displays the help for the specified algorithm.

Note

Please note that open_help requires a working Internet connection.

Author(s)

Jannes Muenchow, Victor Olaya, QGIS core team

Examples

1
2
3
4
5
6
7
## Not run: 
# QGIS example
open_help(alg = "qgis:addfieldtoattributestable")
# GRASS example
open_help(alg = "grass:v.overlay")

## End(Not run)

RQGIS documentation built on Aug. 13, 2018, 5:04 p.m.