qgis_meshexporttimeseries: QGIS algorithm - Export time series values from points of a...

View source: R/qgis_meshexporttimeseries.R

qgis_meshexporttimeseriesR Documentation

QGIS algorithm - Export time series values from points of a mesh dataset

Description

QGIS Algorithm provided by QGIS (native c++) Export time series values from points of a mesh dataset (native:meshexporttimeseries). Extracts a mesh dataset's time series values from points contained in a vector layer This algorithm extracts mesh's dataset time series values from points contained in a vector layer. If the time step is kept to its default value (0 hours), the time step used is the one of the two first datasets of the first selected dataset group.

Usage

qgis_meshexporttimeseries(
  INPUT = qgisprocess:::qgis_default_value(),
  DATASET_GROUPS = qgisprocess:::qgis_default_value(),
  STARTING_TIME = qgisprocess:::qgis_default_value(),
  FINISHING_TIME = qgisprocess:::qgis_default_value(),
  TIME_STEP = qgisprocess:::qgis_default_value(),
  INPUT_POINTS = qgisprocess:::qgis_default_value(),
  COORDINATES_DIGITS = qgisprocess:::qgis_default_value(),
  DATASET_DIGITS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

mesh - Input mesh layer. Path to a mesh layer.

DATASET_GROUPS

meshdatasetgroups - Dataset groups. .

STARTING_TIME

meshdatasettime - Starting time. .

FINISHING_TIME

meshdatasettime - Finishing time. .

TIME_STEP

number - Time step (hours). A numeric 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.

INPUT_POINTS

source - Points for data export. Path to a vector layer.

COORDINATES_DIGITS

number - Digits count for coordinates. A numeric 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.

DATASET_DIGITS

number - Digits count for dataset value. A numeric 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 - Exported data CSV file. 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 - Exported data CSV file


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