R/qgis_extractbyattribute.R
qgis_extractbyattribute.Rd
QGIS Algorithm provided by QGIS (native c++) Extract by attribute (native:extractbyattribute). This algorithm creates a new vector layer that only contains matching features from an input layer. The criteria for adding features to the resulting layer is defined based on the values of an attribute from the input layer.
qgis_extractbyattribute(
INPUT = qgisprocess:::qgis_default_value(),
FIELD = qgisprocess:::qgis_default_value(),
OPERATOR = qgisprocess:::qgis_default_value(),
VALUE = qgisprocess:::qgis_default_value(),
OUTPUT = qgisprocess:::qgis_default_value(),
FAIL_OUTPUT = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
source
- Input layer. Path to a vector layer.
field
- Selection attribute. The name of an existing field. ; delimited list of existing field names.
enum
of ("=", "≠", "", "≥", "", "≤", "begins with", "contains", "is null", "is not null", "does not contain")
- Operator. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
string
- Value. 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.
sink
- Extracted (attribute). Path for new vector layer.
sink
- Extracted (non-matching). 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
.