identifyGATpopulation: Identify GAT Population Variable

In ajstamm/gatpkg: Geographic Aggregation Tool (GAT)

Identify GAT Population Variable

Description

This function opens a dialog window for the user to select which variable in the population shapefile (if population-weighted centroids are requested) should be used to determine area populations.

Figure: Dialog to select base population

Select your desired base population variable. 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

identifyGATpopulation(
  varlist,
  step = 8,
  var = "NONE",
  backopt = TRUE,
  bgcol = "lightskyblue3",
  quitopt = "Quit",
  buttoncol = "cornflowerblue",
  helptitle = "identifyGATpopulation",
  helppage = "identifyGATpopulation",
  helpimg = "",
  tool = "GAT",
  manual = "/docs/dev/articles/gat_tutorial.html",
  help = paste0("Select your base population variable.  \n",
    "  •  To continue,  click 'Next >'. \n",
    "  •  To return to merge type selection, click '< Back'. \n", "  •  To quit ",
    tool, " click '", quitopt, "'.")
)

Arguments

varlist	Vector of names of variables. Within GAT, these variables must be numeric, but the function does not require that.
step	Integer step in the program, for help reference.
var	Population variable to use for weighting, if pre-selected.
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	A text string that denotes the help dialog title.
helppage	A text string that contains the function name for the relevant function (if any) in the help dialog.
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
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.
help	A text string containing help message

Examples

if (interactive()) {
# identify variable to aggregate
identifyGATpopulation(varlist = c("Pop_tot", "F_tot", "M_tot"), step = 7)
}

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