inputGATmessage: Input GAT Message

In ajstamm/gatpkg: Geographic Aggregation Tool (GAT)

Input GAT Message

Description

This function opens a dialog window for the user to confirm the contents of the provided message.

Figure: Message dialog

Select your desired variables and the exclusion criterion for each.

• Click Yes to confirm the message.

• Click No to refuse the message.

• Click Back to return to the previous step.

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

Usage

inputGATmessage(
  title = "GAT input window",
  msg = "Is GAT fun?",
  help = "There is no help.",
  helptitle = "inputGATmessage",
  helppage = "inputGATmessage",
  step = 0,
  quitopt = "Quit",
  backopt = TRUE,
  bgcol = "lightskyblue3",
  buttoncol = "cornflowerblue",
  tool = "GAT",
  manual = "/docs/dev/articles/gat_tutorial.html",
  helpimg = ""
)

Arguments

title	Text string containing the dialog title.
msg	Text string containing the message for the user.
help	Text string containing the help message.
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.
step	Integer step in the GAT program, for help reference.
quitopt	Text string for the cancel button.
backopt	Boolean denoting whether to include the back button.
bgcol	Text string containing UI background color.
buttoncol	Text string containing UI button color.
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

Examples

if (interactive()) {
# define your message
inputGATmessage(title = "Random message window")
}

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