get_usage: Get usage of a specific QGIS geoalgorithm

In RQGIS: Integrating R with QGIS

Description

get_usage lists all function parameters of a specific QGIS geoalgorithm.

Usage

get_usage(alg = NULL, intern = FALSE, qgis_env = set_env())

Arguments

alg	Name of the function whose parameters are being searched for.
intern	Logical, if TRUE the function captures the command line output as an R character vector. IfFALSE', the default, the output is printed to the console in a pretty way.
qgis_env	Environment containing all the paths to run the QGIS API. For more information, refer to set_env().

Details

Function get_usage simply calls processing.alghelp of the QGIS Python API.

Author(s)

Jannes Muenchow, Victor Olaya, QGIS core team

Examples

## Not run: 
# find a function which adds coordinates
find_algorithms(search_term = "add")
# find function arguments of saga:addcoordinatestopoints
get_usage(alg = "saga:addcoordinatestopoints")

## End(Not run)

RQGIS documentation built on May 2, 2019, 8:23 a.m.