get_usage: Get usage of a specific QGIS geoalgorithm

Description Usage Arguments Details Author(s) Examples

View source: R/processing.R

Description

get_usage lists all function parameters of a specific QGIS geoalgorithm.

Usage

1
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

1
2
3
4
5
6
7
## 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 Aug. 13, 2018, 5:04 p.m.