qgis_run_algorithm: Run an algorithm using 'qgis_process'

View source: R/qgis-run-algorithm.R

qgis_run_algorithmR Documentation

Run an algorithm using 'qgis_process'

Description

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 using as_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

if (has_qgis()) {
  qgis_run_algorithm(
    "native:buffer",
    INPUT = system.file("longlake/longlake_depth.gpkg", package = "qgisprocess"),
    DISTANCE = 10
  )
}


paleolimbot/qgisprocess documentation built on May 23, 2023, 10:02 p.m.