qgis_show_help: Get detailed information about one algorithm

In paleolimbot/qgisprocess: Use 'QGIS' Processing Algorithms

Get detailed information about one algorithm

Description

Get detailed information about one algorithm

Usage

qgis_show_help(algorithm)

qgis_get_description(algorithm)

qgis_get_argument_specs(algorithm, ...)

qgis_get_output_specs(algorithm, ...)

Arguments

algorithm	A qualified algorithm name (e.g., "native:buffer").
...	For internal use only.

Value

• qgis_get_description(): a string.

• qgis_get_argument_specs(), qgis_get_output_specs(): a tibble.

• qgis_show_help(): the algorithm name, invisibly.

See Also

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

Examples

qgis_get_description("native:filedownloader")

# not running below examples in R CMD check to save time
qgis_get_argument_specs("native:filedownloader")
qgis_get_output_specs("native:filedownloader")
qgis_show_help("native:filedownloader")

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