sagang_sunriseandsunset: QGIS algorithm - Sunrise and sunset

View source: R/sagang_sunriseandsunset.R

sagang_sunriseandsunsetR Documentation

QGIS algorithm - Sunrise and sunset

Description

QGIS Algorithm provided by SAGA Next Gen Sunrise and sunset (sagang:sunriseandsunset). —————- Arguments —————- TARGET: Target System Argument type: raster Acceptable values: - Path to a raster layer SUNRISE: Sunrise Argument type: rasterDestination Acceptable values: - Path for new raster layer SUNSET: Sunset Argument type: rasterDestination Acceptable values: - Path for new raster layer LENGTH: Day Length Argument type: rasterDestination Acceptable values: - Path for new raster layer DAY: Day of Month Default value: 2021-03-24 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 TIME: Time Default value: 0 Argument type: enum Available values: - 0: (0) local - 1: (1) world Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_sunriseandsunset(
  TARGET = qgisprocess:::qgis_default_value(),
  SUNRISE = qgisprocess:::qgis_default_value(),
  SUNSET = qgisprocess:::qgis_default_value(),
  LENGTH = qgisprocess:::qgis_default_value(),
  DAY = qgisprocess:::qgis_default_value(),
  TIME = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

TARGET

raster - Target System. Path to a raster layer.

SUNRISE

rasterDestination - Sunrise. Path for new raster layer.

SUNSET

rasterDestination - Sunset. Path for new raster layer.

LENGTH

rasterDestination - Day Length. Path for new raster layer.

DAY

string - Day of Month. 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.

TIME

enum of ⁠("(0) local", "(1) world")⁠ - Time. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • LENGTH - outputRaster - Day Length

  • SUNRISE - outputRaster - Sunrise

  • SUNSET - outputRaster - Sunset


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