R/gdal_clipvectorbypolygon.R
gdal_clipvectorbypolygon.Rd
QGIS Algorithm provided by GDAL Clip vector by mask layer (gdal:clipvectorbypolygon). —————- Arguments —————- INPUT: Input layer Argument type: source Acceptable values: - Path to a vector layer MASK: Mask layer Argument type: source Acceptable values: - Path to a vector layer OPTIONS: Additional creation options (optional) Default value: Argument type: string Acceptable values: - 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: Clipped (mask) Argument type: vectorDestination Acceptable values: - Path for new vector layer
gdal_clipvectorbypolygon(
INPUT = qgisprocess:::qgis_default_value(),
MASK = qgisprocess:::qgis_default_value(),
OPTIONS = qgisprocess:::qgis_default_value(),
OUTPUT = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
source
- Input layer. Path to a vector layer.
source
- Mask layer. Path to a vector layer.
string
- Additional creation options. 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.
vectorDestination
- Clipped (mask). Path for new vector layer.
further parameters passed to qgisprocess::qgis_run_algorithm()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.