# GUI Tools Made Easy: Interact with Models and Explore Data

## Documentation for package ‘PBSmodelling’ version 2.70.2

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Code demos. Use demo() to run them.

## Help Pages

A B C D E F G I J L O P R S T U V W misc

PBSmodelling-package | PBS Modelling

## -- A --

addArrows | Add Arrows to a Plot Using Relative (0:1) Coordinates
addHistory | Create Structures for a New History Widget
addLabel | Add a Label to a Plot Using Relative (0:1) Coordinates
addLegend | Add a Legend to a Plot Using Relative (0:1) Coordinates

## -- B --

backHistory | Create Structures for a New History Widget
break-class | S4: Present Talk Classes

## -- C --

calcFib | Calculate Fibonacci Numbers by Several Methods
calcGM | Calculate the Geometric Mean, Allowing for Zeroes
calcMin | Calculate the Minimum of a User-Defined Function
CCA.qbr | Data: Sampled Counts of Quillback Rockfish (Sebastes maliger)
chooseWinVal | Choose and Set a String Item in a GUI
cleanProj | Launch a GUI for Project File Deletion
cleanWD | Launch a GUI for File Deletion
clearAll | Remove all R Objects From a Specified Environment
clearHistory | Create Structures for a New History Widget
clearPBSext | Clear File Extension Associations
clearRcon | Clear the R Console / Focus on the RGui Window
clearWinVal | Remove all Current Widget Variables
clipVector | Clip a Vector at One or Both Ends
closeWin | Close GUI Window(s)
code-class | S4: Present Talk Classes
compileC | Compile a C File into a Shared Library Object
compileDescription | Convert and Save a Window Description as a List
convSlashes | Convert Slashes from UNIX to DOS
createVector | Create a GUI with a Vector Widget
createWin | Create a GUI Window

## -- D --

declareGUIoptions | Declare Option Names that Correspond with Widget Names
doAction | Execute Action Created by a Widget
drawBars | Draw a Linear Barplot on the Current Plot

## -- E --

evalCall | Evaluate a Function Call
expandGraph | Expand the Plot Area by Adjusting Margins
exportHistory | Export a Saved History

## -- F --

file-class | S4: Present Talk Classes
findPat | Search a Character Vector to Find Multiple Patterns
findPrefix | Find a Prefix Based on Names of Existing Files
findProgram | Locates a program in the PATH environment variable
findSuffix | Find a Prefix Based on Names of Existing Files
firstHistory | Create Structures for a New History Widget
focusRgui | Clear the R Console / Focus on the RGui Window
focusWin | Set the Focus on a Particular Window
forwHistory | Create Structures for a New History Widget

## -- G --

genMatrix | Generate Test Matrices for plotBubbles
getChoice | Choose One String Item from a List of Choices
getGUIoptions | Get PBS Options for Widgets
getOptions | Get and Set User Options
getOptionsFileName | Get and Set File Name for Saving and Loading of Options
getOptionsPrefix | Get and Set GUI Prefix of Options Class
getPBSext | Get Command Associated With File Name Extension
getPBSoptions | Retrieve A User Option
getWinAct | Retrieve the Last Window Action
getWinFun | Retrieve Names of Functions Referenced in a Window
getWinVal | Retrieve Widget Values for Use in R Code
getYes | Prompt the User to Choose Yes or No
GT0 | Restrict a Numeric Variable to a Positive Value

## -- I --

importHistory | Import a History List from a File
initHistory | Create Structures for a New History Widget
isWhat | Identify an Object and Print Information

## -- J --

jumpHistory | Create Structures for a New History Widget

## -- L --

lastHistory | Create Structures for a New History Widget
lisp | List Objects in .PBSmodEnv Workspace
loadC | Launch a GUI for Compiling and Loading C Code
loadOptions | Save and Load Options to and from Disk
loadOptionsGUI | Load and Save Options Values to and from a GUI
lucent | Convert Solid Colours to Translucence

## -- O --

openExamples | Open Example Files from a Package
openFile | Open File with Associated Program
openUG | Open Package User Guide

## -- P --

packList | Pack a List with Objects
pad0 | Pad Values with Leading Zeroes
parseWinFile | Convert a Window Description File into a List Object
pause | Pause Between Graphics Displays or Other Calculations
PBSmodelling | PBS Modelling
PBSoptions-class | S4: Project Options Class
pickCol | Pick a Colour From a Palette and get the Hexadecimal Code
plotACF | Plot Autocorrelation Bars From a Data Frame, Matrix, or Vector
plotAsp | Construct a Plot with a Specified Aspect Ratio
plotBubbles | Construct a Bubble Plot from a Matrix
plotCsum | Plot Cumulative Sum of Data
plotDens | Plot Density Curves from a Data Frame, Matrix, or Vector
plotFriedEggs | Render a Pairs Plot as Fried Eggs and Beer
plotSidebars | Plot Table as Horizontal Sidebars
plotTrace | Plot Trace Lines from a Data Frame, Matrix, or Vector
presentTalk | Run a Presentation in R
print-method | S4: Project Options Class
promptWriteOptions | Prompt the User to Write Changed Options

## -- R --

readList | Read a List from an ASCII File
readPBSoptions | Read PBS Options from an External File
resetGraph | Reset par Values for a Plot
restorePar | Get Actual Parameters from Scaled Values
rmHistory | Create Structures for a New History Widget
runDemos | Interactive GUI for R Demos
runExample | Run a Single GUI Example Included with PBS Modelling
runExamples | Run GUI Examples Included with PBS Modelling

## -- S --

saveOptions | Save and Load Options to and from Disk
saveOptionsAs | Save and Load Options to and from Disk
saveOptionsGUI | Load and Save Options Values to and from a GUI
scalePar | Scale Parameters to [0,1]
section-class | S4: Present Talk Classes
selectDir | Display Dialogue: Select directory
selectFile | Display Dialogue: Open or Save File
setFileOption | Set a PBS File Path Option Interactively
setGUIoptions | Set PBS Options from Widget Values
setOptions | Get and Set User Options
setOptionsFileName | Get and Set File Name for Saving and Loading of Options
setOptionsPrefix | Get and Set GUI Prefix of Options Class
setPathOption | Set a PBS Path Option Interactively
setPBSext | Set Command to Associate with File Name Extension
setPBSoptions | Set A User Option
setwdGUI | Browse for Working Directory and Optionally Find Prefix
setWidgetColor | Update Widget Color
setWidgetState | Update Widget State
setWinAct | Add a Window Action to the Saved Action Vector
setWinVal | Update Widget Values
show-method | S4: Project Options Class
show0 | Convert Numbers into Text with Specified Decimal Places
showAlert | Display a Message in an Alert Window
showArgs | Display Expected Widget Arguments
showHelp | Display HTML Help Pages for Packages in Browser
showPacks | Show Packages Required But Not Installed
showRes | Show Results of Expression Represented by Text
showVignettes | Display Vignettes for Packages
sortHistory | Sort an Active or Saved History

## -- T --

talk-class | S4: Present Talk Classes
tcall | Get/Put Objects From/To Temporary Work Environment
testAlpha | Test Various Alpha Transparency Values
testCol | Display Colours Available Using a Set of Strings
testLty | Display Line Types Available
testLwd | Display Line Widths
testWidgets | Display Sample GUIs and their Source Code
text-class | S4: Present Talk Classes
tget | Get/Put Objects From/To Temporary Work Environment
tprint | Get/Put Objects From/To Temporary Work Environment
tput | Get/Put Objects From/To Temporary Work Environment

## -- U --

unpackList | Unpack List Elements into Variables
updateGUI | Update Active GUI With Local Values

## -- V --

vbdata | Data: Lengths-at-Age for von Bertalanffy Curve
vbpars | Data: Initial Parameters for a von Bertalanffy Curve
view | View First/Last/Random n Elements/Rows of an Object
viewCode | View Package R Code

## -- W --

widgets | Display Sample GUIs and their Source Code
writeList | Write a List to a File in PBS Modelling Format
writePBSoptions | Write PBS Options to an External File

## -- misc --

.addslashes | Dot Support Functions
.adjustAllColours | Dot GUI Functions
.autoConvertMode | Dot GUI Functions
.buildgrid | Dot GUI Functions
.catError | Dot GUI Functions
.catError2 | Dot GUI Functions
.check.object.exists | Dot GUI Functions
.cleanLoadC | Dot C Support Functions
.convertMatrixListToDataFrame | Dot Convert Functions
.convertMatrixListToMatrix | Dot Convert Functions
.convertMode | Dot Convert Functions
.convertOldGridToNewGrid | Dot Convert Functions
.convertParamStrToList | Dot Convert Functions
.convertParamStrToVector | Dot Convert Functions
.convertVecToArray | Dot Convert Functions
.createTkFont | Dot Create Functions
.createWidget | Dot Create Functions
.createWidget.button | Dot Create Functions
.createWidget.check | Dot Create Functions
.createWidget.data | Dot Create Functions
.createWidget.droplist | Dot Create Functions
.createWidget.entry | Dot Create Functions
.createWidget.grid | Dot Create Functions
.createWidget.history | Dot History Functions
.createWidget.image | Dot Create Functions
.createWidget.include | Dot Create Functions
.createWidget.label | Dot Create Functions
.createWidget.matrix | Dot Create Functions
.createWidget.notebook | Dot Create Functions
.createWidget.null | Dot Create Functions
.createWidget.object | Dot Create Functions
.createWidget.object.scrolling | Dot Create Functions
.createWidget.progressbar | Dot Create Functions
.createWidget.radio | Dot Create Functions
.createWidget.slide | Dot Create Functions
.createWidget.slideplus | Dot Create Functions
.createWidget.spinbox | Dot Create Functions
.createWidget.table | Dot Create Functions
.createWidget.text | Dot Create Functions
.createWidget.vector | Dot Create Functions
.dClose | Dot Support Functions
.do.gui.call | Dot GUI Functions
.doClean | Dot Project Functions
.doCleanWD | Dot Project Functions
.dUpdateDesc | Dot Support Functions
.extractData | Dot GUI Functions
.extractFuns | Dot GUI Functions
.extractVar | Dot GUI Functions
.fibC | Dot Support Functions
.fibCall | Dot Support Functions
.fibClosedForm | Dot Support Functions
.fibR | Dot Support Functions
.findSquare | Dot Support Functions
.forceMode | Dot Support Functions
.getArrayPts | Dot Support Functions
.getButton | Dot Talk Functions
.getButtons | Dot Talk Functions
.getHiddenEnv | Dot Project Functions
.getHome | Dot Project Functions
.getIndexForSection | Dot Talk Functions
.getMatrixListSize | Dot GUI Functions
.getMenus | Dot Talk Functions
.getParamFromStr | Dot GUI Functions
.getPrefix | Dot Project Functions
.getSectionNames | Dot Talk Functions
.getSimilarColour | Dot GUI Functions
.getTalkIndexes | Dot Talk Functions
.getValueForWidgetSetup | Dot GUI Functions
.guiCompileC | Dot C Support Functions
.guiDyn | Dot C Support Functions
.guiSource | Dot C Support Functions
.inCollection | Dot GUI Functions
.initPBSoptions | Dot Support Functions
.libName | Dot C Support Functions
.loadCRunComparison | Dot C Support Functions
.makeCleanVec | Dot Project Functions
.map.add | Dot GUI Functions
.map.get | Dot GUI Functions
.map.getAll | Dot GUI Functions
.map.init | Dot GUI Functions
.map.set | Dot GUI Functions
.mapArrayToVec | Dot Support Functions
.matrixHelp | Dot GUI Functions
.maxActionSize | Dot Widget Definitions
.mergeLists | Dot List Functions
.mergeLists2 | Dot Project Functions
.mergeVectors | Dot Project Functions
.nextSlide | Dot Talk Functions
.optionsNotUpdated | Dot Project Functions
.packWidgetsIntoGrid | Dot GUI Functions
.parsegrid | Dot GUI Functions
.parsemenu | Dot GUI Functions
.parseTalkFile | Dot Talk Functions
.PBSdimnameHelper | Dot GUI Functions
.PBSmodEnv | PBSmodelling Environment
.pFormatDefs | Dot Widget Definitions
.presentTalkOpenFile | Dot Talk Functions
.prevSlide | Dot Talk Functions
.readList.C | Dot List Functions
.readList.P | Dot List Functions
.readList.P.convertData | Dot List Functions
.regex.complex | Dot Widget Definitions
.regex.logical | Dot Widget Definitions
.regex.numeric | Dot Widget Definitions
.removeFromList | Dot Project Functions
.searchCollection | Dot GUI Functions
.sectiondrop | Dot Talk Functions
.selectCleanBoxes | Dot Project Functions
.setMatrixElement | Dot GUI Functions
.setOption | Dot Project Functions
.setsection | Dot Talk Functions
.setWinValHelper | Dot GUI Functions
.showLog | Dot Project Functions
.showOptions | Get and Set User Options
.slidedrop | Dot Talk Functions
.sortHelper | Dot History Functions
.sortHelperActive | Dot History Functions
.sortHelperFile | Dot History Functions
.sortWidget | Dot History Functions
.startSlide | Dot Talk Functions
.stopWidget | Dot GUI Functions
.stripComments | Dot GUI Functions
.stripExt | Dot Project Functions
.stripSlashes | Dot GUI Functions
.stripSlashesVec | Dot GUI Functions
.superobject.redraw | Dot GUI Functions
.superobject.saveValues | Dot GUI Functions
.table.getvalue | Dot GUI Functions
.table.setvalue | Dot GUI Functions
.tagDefs | Dot Widget Definitions
.tagOptionChecks | Dot Widget Definitions
.tclArrayToVector | Dot Support Functions
.trimWhiteSpace | Dot GUI Functions
.tryOpen | Dot Project Functions
.updateFile | Dot History Functions
.updateHistory | Dot History Functions
.updateHistoryButtons | Dot History Functions
.updateSlide | Dot Talk Functions
.validateWindowDescList | Dot GUI Functions
.validateWindowDescWidgets | Dot GUI Functions
.viewPkgDemo | Dot Support Functions
.viewPkgVignette | Dot Support Functions
.widgetDefs | Dot Widget Definitions
.win.chFile | GUI Windows Wrappers
.win.chTest | GUI Windows Wrappers
.win.closeALL | GUI Windows Wrappers
.win.closeChoice | GUI Windows Wrappers
.win.closeSDE | GUI Windows Wrappers
.win.makeChoice | GUI Windows Wrappers
.win.restoreCWD | GUI Windows Wrappers
.win.runExHelperQuit | GUI Windows Wrappers
.win.tcall | GUI Windows Wrappers
.win.tget | GUI Windows Wrappers
.win.tprint | GUI Windows Wrappers
.writeList.P | Dot List Functions