Retrieve information about available processing algorithms.

processing.alglist(search = NULL, ...)

processing.alghelp(alg, ...)

processing.algoptions(alg, ...)

Arguments

search

only return processing algorithms whose name or description include the search string

...

low-level parameters (such as host and auth) to be passed on to qgisremote()

alg

the unique name of the algorithm to show information for

Value

For processing.alglist(): a named list mapping algorithm names to descriptions.

Functions

  • processing.alghelp: processing.alghelp() shows information about all arguments to the given algorithm.

  • processing.algoptions: processing.algoptions() shows only information on the optional parameters of the given algorithm.

See also

processing.runalg()