Show algorithm help
qgis_show_help(algorithm)
qgis_description(algorithm)
qgis_arguments(algorithm)
qgis_outputs(algorithm)
qgis_help(algorithm)A qualified algorithm name (e.g., "native:filedownloader") or a path to a QGIS model file.
if (has_qgis()) qgis_show_help("native:filedownloader")
#> Download file (native:filedownloader)
#>
#> ----------------
#> Description
#> ----------------
#> This algorithm downloads a URL on the file system.
#>
#> ----------------
#> Arguments
#> ----------------
#>
#> URL: URL
#> Argument type: string
#> Acceptable values:
#> - String value
#> METHOD: Method
#> Default value: 0
#> The HTTP method to use for the request
#> Argument type: enum
#> Available values:
#> - 0: GET
#> - 1: POST
#> Acceptable values:
#> - Number of selected option, e.g. '1'
#> - Comma separated list of options, e.g. '1,3'
#> DATA: Data (optional)
#> The data to add in the body if the request is a POST
#> Argument type: string
#> Acceptable values:
#> - String value
#> OUTPUT: File destination (optional)
#> Argument type: fileDestination
#> Acceptable values:
#> - Path for new file
#>
#> ----------------
#> Outputs
#> ----------------
#>
#> OUTPUT: <outputFile>
#> File destination
#>
#>
#>
if (has_qgis()) qgis_description("native:filedownloader")
#> native:filedownloader
#> "This algorithm downloads a URL on the file system."
if (has_qgis()) qgis_arguments("native:filedownloader")
#> # A tibble: 4 × 6
#> name description qgis_type default_value available_values accep…¹
#> <chr> <chr> <chr> <list> <list> <list>
#> 1 URL URL string <NULL> <NULL> <chr>
#> 2 METHOD Method enum <int [1]> <chr [2]> <chr>
#> 3 DATA Data string <NULL> <NULL> <chr>
#> 4 OUTPUT File destination fileDestination <NULL> <NULL> <chr>
#> # … with abbreviated variable name ¹acceptable_values