RQGIS (version 0.2.0)

get_usage: Get usage of a specific QGIS geoalgorithm

Description

get_usage lists all function parameters of a specific QGIS geoalgorithm.

Usage

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

Arguments

alg

Name of the function whose parameters are being searched for.

qgis_env

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

intern

Logical, if TRUE the function captures the command line output as an R character vector (see also system).

Details

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

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")
# }