Search geoprocessing algorithms

Searches for algorithms using a regular expression. In its simplest form that is just a string that must match part of a character value.

Usage

qgis_search_algorithms(
  algorithm = NULL,
  provider = NULL,
  group = NULL,
  include_deprecated = FALSE
)

Arguments

algorithm

Regular expression to match the algorithm or algorithm_title value from the output of qgis_algorithms().

provider

Regular expression to match the provider or provider_title value from the output of qgis_algorithms().

group

Regular expression to match the group value from the output of qgis_algorithms().

include_deprecated

Logical. Should deprecated algorithms be included?

Value

A tibble.

Details

When using multiple arguments in combination, only the algorithms are returned that fulfill all conditions.

All regular expressions that stringr::str_detect() can handle, are accepted. Have a look at stringi::search_regex() to get a nice overview.

See also

Other topics about information on algorithms & processing providers: qgis_algorithms(), qgis_show_help()

Examples

qgis_search_algorithms(
  algorithm = "point.*line",
  provider = "^native$"
)
#> # A tibble: 3 × 5
#>   provider provider_title    group           algorithm           algorithm_title
#>   <chr>    <chr>             <chr>           <chr>               <chr>          
#> 1 native   QGIS (native c++) Vector geometry native:interpolate… Interpolate po…
#> 2 native   QGIS (native c++) Vector geometry native:pointsalong… Points along g…
#> 3 native   QGIS (native c++) Vector creation native:randompoint… Random points …