grass_m_cogo: QGIS algorithm - m.cogo

View source: R/grass_m_cogo.R

grass_m_cogoR Documentation

QGIS algorithm - m.cogo

Description

QGIS Algorithm provided by GRASS m.cogo (grass:m.cogo). A simple utility for converting bearing and distance measurements to coordinates and vice versa. It assumes a Cartesian coordinate system

Usage

grass_m_cogo(
  input = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  coordinates = qgisprocess:::qgis_default_value(),
  .l = qgisprocess:::qgis_default_value(),
  .q = qgisprocess:::qgis_default_value(),
  .r = qgisprocess:::qgis_default_value(),
  .c = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input

file - Name of input file. Path to a file.

output

fileDestination - Output text file. Path for new file.

coordinates

point - Starting coordinate pair. Point coordinate as an 'x,y' string, e.g. '1.5,10.1'.

.l

boolean - Lines are labelled. 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. Original algorithm parameter name: -l.

.q

boolean - Suppress warnings. 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. Original algorithm parameter name: -q.

.r

boolean - Convert from coordinates to bearing and distance. 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. Original algorithm parameter name: -r.

.c

boolean - Repeat the starting coordinate at the end to close a loop. 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. Original algorithm parameter name: -c.

GRASS_REGION_PARAMETER

extent - GRASS GIS region 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..

...

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 - Output text file


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