identifyGATid: Identify GAT Shapefile Identifier

View source: R/identifyGATid.R

identifyGATidR Documentation

Identify GAT Shapefile Identifier

Description

This function opens a dialog window for the user to select which identifying variable in the shapefile should be used to label the polygons for aggregation. The dialog window looks like this.

identifyGATid.png

Figure: Dialog to select your identifier variable

Click on your desired identifier in the drop-down list. Then click on one of the following buttons.

  • Click Next to continue to the next step.

  • Click Cancel to end GAT.

  • Click Back to return to the previous step.

  • Click Help to get further guidance and open this manual.

Usage

identifyGATid(
  shp,
  step = 2,
  backopt = TRUE,
  bgcol = "lightskyblue3",
  quitopt = "Quit",
  buttoncol = "cornflowerblue",
  helptitle = "the identification variable",
  helppage = "identifyGATid",
  tool = "GAT",
  manual = "/docs/dev/articles/gat_tutorial.html",
  helpimg = ""
)

Arguments

shp

Spatial layer.

step

Integer step in the GAT program, for help reference.

backopt

Boolean denoting whether to include the back button.

bgcol

Text string containing UI background color.

quitopt

Text string for the cancel button.

buttoncol

Text string containing UI button color.

helptitle

Text string containing the title bar for the help window.

helppage

Text string for function name for the relevant function (if any) in the help dialog.

tool

A text string that contains the name of the tool

manual

Text String containing the relative path of the tool instruction manual. For GAT, it is relative to the gatpkg directory, otherwise it is relative to the working directory.

helpimg

A text string denoting the file name of the GAT PNG image to be shown, or path and filename of other image to be shown, (PNF, PFM, PPM, GIF) relative to the current working directory

Details

This variable will be duplicated and modified by the aggregation to provide new identifiers for newly created polygons. Any unmerged polygons will retain their original identifiers.

Examples


if (interactive()) {
# identify the character variable to use as the ID
identifyGATid(shp = hftown)
}


ajstamm/gatpkg documentation built on Nov. 23, 2023, 9:44 a.m.