inputGATexclusions: Input GAT Exclusions

View source: R/inputGATexclusions.R

inputGATexclusionsR Documentation

Input GAT Exclusions

Description

This function opens a dialog window for the user to select the variables to be used when identifying exclusions.

inputGATexclusions.png

Figure: Dialog to select your rate settings

Select your desired variables and the exclusion criterion for each.

  • 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

inputGATexclusions(
  shp,
  step = 0,
  exclist = NULL,
  backopt = TRUE,
  bgcol = "lightskyblue3",
  quitopt = "Quit",
  buttoncol = "cornflowerblue"
)

Arguments

shp

Spatial layer.

step

Integer step in the GAT program, for help reference.

exclist

The list of exclusion criteria, if pre-defined.

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.

Details

Change the limitdenom option from FALSE to TRUE in step 9 (requesting rate calculation information) in runGATprogram if you want to allow only denominators with finite, non-zero values.

This function is very basic and can only handle numeric variables, so if you need to exclude based on a character variable, such as county name, you will need to create a numeric flag variable to use in this step.

If you have more than three exclusion criteria, you will need to create a composite flag variable that you can use in this step.

This function returns a list with the following nine elements:

var1, var2, var3: The names of the three variables to use when determining exclusions.

math1, math2, math3: The mathematical operators to use when calculating exclusions. Options are "equals", "less than", and "greater than".

val1, val2, val3: The values to use in the exclusion calculations.

Examples


if (interactive()) {
inputGATexclusions(shp = hftown)
}


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