qgis_run_algorithm_p: Run an algorithm using 'qgis_process': pipe-friendly wrapper

In paleolimbot/qgisprocess: Use 'QGIS' Processing Algorithms

Run an algorithm using 'qgis_process': pipe-friendly wrapper

Description

qgis_run_algorithm_p() wraps qgis_run_algorithm(), passing its first argument to the first argument of the QGIS algorithm. This makes it more convenient in a pipeline (hence '_p' in the name).

Usage

qgis_run_algorithm_p(
  .data,
  algorithm,
  ...,
  .select = "OUTPUT",
  .clean = TRUE,
  .quiet = TRUE
)

Arguments

.data	Passed to the first input of algorithm. If .data is a qgis_result (the result of a previous processing step), .data[[.select]] is passed instead.
algorithm	A qualified algorithm name (e.g., "native:buffer").
...	Other algorithm arguments. These values are evaluated once and immediately, so you shouldn't call qgis_tmp_file() here.
.select	String. The name of the element to select from .data if the latter is a qgis_result. Defaults to "OUTPUT".
.clean	Logical. Should an incoming qgis_result be cleaned (using qgis_clean_result()) after processing?
.quiet	Use FALSE to get extra output from 'qgis_process'. This can be useful in debugging.

Details

Uses qgis_function() under the hood.

Value

A qgis_result object.

See Also

Other functions to run one geoprocessing algorithm: qgis_run_algorithm()

Examples

system.file(
  "longlake/longlake_depth.gpkg",
  package = "qgisprocess"
) |>
  qgis_run_algorithm_p(
    "native:buffer",
    DISTANCE = 10
  )

paleolimbot/qgisprocess documentation built on Feb. 27, 2024, 9:52 p.m.