Run a processing algorithm on the given data.

processing.runalg(alg, ..., .apiargs = NULL)

Arguments

alg

the unique name of the processing algorithm

...

arguments to the processing algorithm. These should either all be named (using the parameter names given by processing.alghelp()), or all be unnamed, in which case their relative order has to correspond to the processing algorithm's argument positions. All argument types are preserved with the exception of qgislayer() objects, for which only their layer id is transferred as a string. The Network API plugin will look up and pass the corresponding layer objects to the processing algorithm within QGIS.

.apiargs

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

Value

The return value of the processing algorithm.

See also

processing.alglist()

Examples

## processing.runalg("gdalogr:proximity", INPUT = "qgislayerid123", OUTPUT = "outfilename.tif", ## VALUES = 1, RTYPE = 4)