qgis_filedownloader: QGIS algorithm - Download file

View source: R/qgis_filedownloader.R

qgis_filedownloaderR Documentation

QGIS algorithm - Download file

Description

QGIS Algorithm provided by QGIS (native c++) Download file (native:filedownloader). This algorithm downloads a URL on the file system.

Usage

qgis_filedownloader(
  URL = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  DATA = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

URL

string - URL. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

METHOD

enum of ⁠("GET", "POST")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

DATA

string - Data. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

OUTPUT

fileDestination - File destination. Path for new file.

...

further parameters passed to qgisprocess::qgis_run_algorithm()

.complete_output

logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.

.quiet

logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.

.messages

logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

  • OUTPUT - outputFile - File destination


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.