R/qgis_randomextractwithinsubsets.R
qgis_randomextractwithinsubsets.Rd
QGIS Algorithm provided by QGIS Random extract within subsets (qgis:randomextractwithinsubsets). This algorithm takes a vector layer and generates a new one that contains only a subset of the features in the input layer. The subset is defined randomly, using a percentage or count value to define the total number of features in the subset. The percentage/count value is not applied to the whole layer, but instead to each category. Categories are defined according to a given attribute, which is also specified as an input parameter for the algorithm.
qgis_randomextractwithinsubsets(
INPUT = qgisprocess:::qgis_default_value(),
FIELD = qgisprocess:::qgis_default_value(),
METHOD = qgisprocess:::qgis_default_value(),
NUMBER = 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.
field
- ID field. The name of an existing field. ; delimited list of existing field names.
enum
of ("Number of selected features", "Percentage of selected features")
- Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number
- Number/
percentage of selected features. 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.
sink
- Extracted (random stratified). 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
.