RQGIS (version 0.2.0)

find_algorithms: Find and list available QGIS algorithms

Description

find_algorithms lists or queries all QGIS algorithms which can be used accessed through the command line.

Usage

find_algorithms(search_term = "", qgis_env = set_env(), name_only = FALSE,
  intern = ifelse(Sys.info()["sysname"] == "Windows", TRUE, FALSE))

Arguments

search_term

A character to query QGIS functions, i.e. to list only functions which contain the indicated string. If empty (""), the default, all available functions will be returned.

qgis_env

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

name_only

If TRUE, the function returns only the name(s) of the found algorithms. Otherwise, a short function description will be returned as well (default).

intern

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

Value

The function returns QGIS function names and short descriptions as an R character vector.

Details

Function find_algorithms simply calls processing.alglist using Python.

Examples

# NOT RUN {
# list all available QGIS algorithms on your system
algs <- find_algorithms()
algs[1:15]
# just find all native, i.e. QGIS-algorithms
grep("qgis:", algs, value = TRUE)
# find a function which adds coordinates
find_algorithms(search_term = "add")
# }