qgis_package: QGIS algorithm - Package layers

View source: R/qgis_package.R

qgis_packageR Documentation

QGIS algorithm - Package layers

Description

QGIS Algorithm provided by QGIS (native c++) Package layers (native:package). This algorithm collects a number of existing layers and packages them together into a single GeoPackage database.

Usage

qgis_package(
  LAYERS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  OVERWRITE = qgisprocess:::qgis_default_value(),
  SAVE_STYLES = qgisprocess:::qgis_default_value(),
  SAVE_METADATA = qgisprocess:::qgis_default_value(),
  SELECTED_FEATURES_ONLY = qgisprocess:::qgis_default_value(),
  EXPORT_RELATED_LAYERS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LAYERS

multilayer - Input layers. .

OUTPUT

fileDestination - Destination GeoPackage. Path for new file.

OVERWRITE

boolean - Overwrite existing GeoPackage. 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.

SAVE_STYLES

boolean - Save layer styles into GeoPackage. 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.

SAVE_METADATA

boolean - Save layer metadata into GeoPackage. 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.

SELECTED_FEATURES_ONLY

boolean - Save only selected features. 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.

EXPORT_RELATED_LAYERS

boolean - Export related layers following relations defined in the project. 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.

...

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 - Destination GeoPackage

  • OUTPUT_LAYERS - outputMultilayer - Layers within new package


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