showGAThelp: Show GAT Help Pages

In ajstamm/gatpkg: Geographic Aggregation Tool (GAT)

Show GAT Help Pages

Description

This function creates a dialog box to provide the user with additional assistance in using GAT, including instructions and links to help pages.

Usage

showGAThelp(
  help = "Find help here.",
  helppage = "showGAThelp",
  step = 0,
  helptitle = "this step",
  helpimg = "",
  tool = "GAT",
  bgcol = "lightskyblue3",
  buttoncol = "cornflowerblue",
  manual = "/docs/dev/articles/gat_tutorial.html"
)

Arguments

help	A text string containing the help message.
helppage	A text string that contains the function name for the relevant function (if any) in the help dialog.
step	Integer step in the GAT program, for help reference.
helptitle	The step name to display in the title bar.
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 denoting the name of the tool
bgcol	Text string containing UI background color.
buttoncol	Text string containing UI button color.
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()) {
showGAThelp(helptitle = "GAT help dialog")
}

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