RQGIS (version 0.1.0)

open_help: Access the QGIS/GRASS online help for a specific function

Description

open_help opens the online help for a specific function. This is the help you also encounter in the QGIS GUI. Please note that you are referred to the GRASS documentation in the case of GRASS algorithms.

Usage

open_help(alg = NULL, qgis_env = set_env())

Arguments

alg

The name of the algorithm for which you wish 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.

Value

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

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.

Examples

## Not run: 
# # QGIS example
# open_help(alg = "qgis:addfieldtoattributestable")
# # GRASS example
# open_help(alg = "grass:v.overlay")
# ## End(Not run)