Runs an algorithm using 'qgis_process'. See the QGIS docs for a detailed description of the algorithms provided 'out of the box' on QGIS.
Usage
qgis_run_algorithm(
algorithm,
...,
PROJECT_PATH = NULL,
ELLIPSOID = NULL,
.raw_json_input = NULL,
.quiet = TRUE
)
Arguments
- algorithm
A qualified algorithm name (e.g.,
"native:buffer"
) or a path to a QGIS model file.- ...
Named key-value pairs as arguments for the algorithm. Features of
rlang::list2()
are supported. These arguments are converted to strings usingas_qgis_argument()
.- PROJECT_PATH, ELLIPSOID
Global values for QGIS project file and ellipsoid name for distance calculations.
- .raw_json_input
The raw JSON to use as input in place of
...
.- .quiet
Use
FALSE
to get extra output from 'qgis_process'. This can be useful in debugging.
See also
Other functions to run one geoprocessing algorithm:
qgis_run_algorithm_p()
Examples
qgis_run_algorithm(
"native:buffer",
INPUT = system.file("longlake/longlake_depth.gpkg", package = "qgisprocess"),
DISTANCE = 10
)
#> Argument `SEGMENTS` is unspecified (using QGIS default value).
#> Using `END_CAP_STYLE = "Round"`
#> Using `JOIN_STYLE = "Round"`
#> Argument `MITER_LIMIT` is unspecified (using QGIS default value).
#> Argument `DISSOLVE` is unspecified (using QGIS default value).
#> Argument `SEPARATE_DISJOINT` is unspecified (using QGIS default value).
#> Using `OUTPUT = qgis_tmp_vector()`
#> <Result of `qgis_run_algorithm("native:buffer", ...)`>
#> List of 1
#> $ OUTPUT: 'qgis_outputVector' chr "/tmp/RtmpIf9gpr/file2dff1716c5/file2dff13109a5f.gpkg"