RQGIS (version 0.1.0)

get_usage: Get usage of a specific GIS function

Description

get_usage lists all function parameters of a specific GIS function.

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 which indicates whether to capture the output of the command as an R character vector (see also system.

Details

Function get_usage simply calls processing.alghelp using Python.

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)