qgis_regularpoints: QGIS algorithm - Regular points

View source: R/qgis_regularpoints.R

qgis_regularpointsR Documentation

QGIS algorithm - Regular points

Description

QGIS Algorithm provided by QGIS Regular points (qgis:regularpoints). This algorithm creates a point layer with a given number of regular points, all of them within a given extent.

Usage

qgis_regularpoints(
  EXTENT = qgisprocess:::qgis_default_value(),
  SPACING = qgisprocess:::qgis_default_value(),
  INSET = qgisprocess:::qgis_default_value(),
  RANDOMIZE = qgisprocess:::qgis_default_value(),
  IS_SPACING = qgisprocess:::qgis_default_value(),
  CRS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

EXTENT

extent - Input extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..

SPACING

distance - Point spacing/count. 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.

INSET

distance - Initial inset from corner (LH side). 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.

RANDOMIZE

boolean - Apply random offset to point spacing. 1 for true/yes. 0 for false/no. 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.

IS_SPACING

boolean - Use point spacing. 1 for true/yes. 0 for false/no. 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.

CRS

crs - Output layer CRS. CRS as an auth ID (e.g. 'EPSG:3111'). CRS as a PROJ4 string (e.g. 'PROJ4:…'). CRS as a WKT string (e.g. 'WKT:…'). Path to a layer. The CRS of the layer is used..

OUTPUT

sink - Regular points. Path for new vector layer.

...

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 - outputVector - Regular points


JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.