RQGIS (version 0.1.0)

find_algorithms: Find and list available QGIS algorithms

Description

find_algorithms lists or queries all algorithms which can be used via the command line and the QGIS API.

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.

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

Value

Python console output will be captured 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")
# ## End(Not run)