inputGATvalue: Input GAT Value

In ajstamm/gatpkg: Geographic Aggregation Tool (GAT)

Input GAT Value

Description

This function creates a dialog box to ask the user for a specific value and provides a link to the relevant help file in the GAT program.

Figure: Dialog to enter an alphanumeric value

Usage

inputGATvalue(
  title = "GAT input window",
  helppage = NULL,
  step = 0,
  help = "Enter the desired value and click 'Next >'.",
  message = "Please enter something in the box.",
  defaulttext = "default text",
  helptitle = "this step",
  backopt = TRUE,
  bgcol = "lightskyblue3",
  quitopt = "Quit",
  buttoncol = "cornflowerblue",
  helpopt = TRUE,
  tool = "GAT",
  manual = "/docs/dev/articles/gat_tutorial.html"
)

Arguments

title	A text string that denotes the dialog title.
helppage	A text string that contains the funcion name for the relevant function (if any) in the help dialog.
step	Integer step in the GAT program, for help reference.
help	A text string containing the help message.
message	A text string stating the request or message for the user.
defaulttext	A text string that is pre-entered in the text box.
helptitle	The step name to display in the title bar.
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.
helpopt	Boolean denoting whether to include the help button.
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.

Examples

if (interactive()) {
inputGATvalue(title = "Learning your name",
              message = "Please enter your name.",
              defaulttext = "Charlie Brown")
}

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