Package: PBSmodelling 2.70.2

Nick Fisch

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

Provides software to facilitate the design, testing, and operation of computer models. It focuses particularly on tools that make it easy to construct and edit a customized graphical user interface ('GUI'). Although our simplified 'GUI' language depends heavily on the R interface to the 'Tcl/Tk' package, a user does not need to know 'Tcl/Tk'. Examples illustrate models built with other R packages, including 'PBSmapping', 'PBSddesolve', and 'BRugs'. A complete user's guide 'PBSmodelling-UG.pdf' shows how to use this package effectively.

Authors:Jon T. Schnute [aut], Alex Couture-Beil [aut], Rowan Haigh [aut], Nicholas Boers [aut], Anisa Egeli [aut], A. R. Kronlund [ctb], Steve Martell [ctb], Norm Olsen [ctb], Nick Fisch [cre]

# Install 'PBSmodelling' in R:

install.packages('PBSmodelling', repos = c('https://pbs-software.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pbs-software/pbs-modelling/issues

Datasets:

CCA.qbr - Data: Sampled Counts of Quillback Rockfish
vbdata - Data: Lengths-at-Age for von Bertalanffy Curve
vbpars - Data: Initial Parameters for a von Bertalanffy Curve

On CRAN:

6.82 score 2 stars 4 packages 152 scripts 1.8k downloads 281 exports 1 dependencies

Last updated from:8558c88ebe. Checks:13 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	202
linux-devel-x86_64	OK	215
source / vignettes	OK	203
linux-release-arm64	OK	182
linux-release-x86_64	OK	215
macos-release-arm64	OK	152
macos-release-x86_64	OK	338
macos-oldrel-arm64	OK	117
macos-oldrel-x86_64	OK	203
windows-devel	OK	116
windows-release	OK	103
windows-oldrel	OK	120
wasm-release	OK	104

Exports:.addslashes .autoConvertMode .buildgrid .catError .catError2 .check.object.exists .cleanLoadC .convertMatrixListToDataFrame .convertMatrixListToMatrix .convertMode .convertOldGridToNewGrid .convertParamStrToList .convertParamStrToVector .convertVecToArray .createTkFont .createWidget .createWidget.button .createWidget.check .createWidget.data .createWidget.droplist .createWidget.entry .createWidget.grid .createWidget.history .createWidget.image .createWidget.include .createWidget.label .createWidget.matrix .createWidget.notebook .createWidget.null .createWidget.object .createWidget.object.scrolling .createWidget.progressbar .createWidget.radio .createWidget.slide .createWidget.slideplus .createWidget.spinbox .createWidget.table .createWidget.text .createWidget.vector .dClose .do.gui.call .doClean .doCleanWD .dUpdateDesc .extractData .extractFuns .extractVar .fibC .fibCall .fibClosedForm .fibR .findSquare .forceMode .getArrayPts .getButton .getButtons .getHiddenEnv .getHome .getIndexForSection .getMatrixListSize .getMenus .getParamFromStr .getPrefix .getSectionNames .getSimilarColour .getTalkIndexes .getValueForWidgetSetup .guiCompileC .guiDyn .guiSource .inCollection .initPBSoptions .loadCRunComparison .makeCleanVec .map.add .map.get .map.getAll .map.init .map.set .mapArrayToVec .matrixHelp .maxActionSize .mergeLists .mergeLists2 .mergeVectors .nextSlide .optionsNotUpdated .packWidgetsIntoGrid .parsegrid .parsemenu .parseTalkFile .PBSdimnameHelper .PBSmodEnv .pFormatDefs .presentTalkOpenFile .prevSlide .readList.C .readList.P .readList.P.convertData .regex.complex .regex.logical .regex.numeric .removeFromList .searchCollection .sectiondrop .selectCleanBoxes .setMatrixElement .setOption .setsection .setWinValHelper .showLog .showOptions .slidedrop .sortHelper .sortHelperActive .sortHelperFile .sortWidget .startSlide .stopWidget .stripComments .stripExt .stripSlashes .stripSlashesVec .superobject.redraw .superobject.saveValues .table.getvalue .table.setvalue .tagDefs .tagOptionChecks .tclArrayToVector .trimWhiteSpace .tryOpen .updateFile .updateHistory .updateHistoryButtons .updateSlide .validateWindowDescList .validateWindowDescWidgets .viewPkgDemo .viewPkgVignette .widgetDefs .win.chFile .win.chTest .win.closeALL .win.closeChoice .win.closeSDE .win.makeChoice .win.restoreCWD .win.runExHelperQuit .win.tcall .win.tget .win.tprint .writeList.P addArrows addHistory addLabel addLegend backHistory calcFib calcGM calcMin chooseWinVal cleanProj cleanWD clearAll clearHistory clearPBSext clearRcon clearWinVal clipVector closeWin compileC compileDescription convSlashes createVector createWin declareGUIoptions doAction drawBars evalCall expandGraph exportHistory findPat findPrefix findProgram findSuffix firstHistory focusRgui focusWin forwHistory genMatrix getChoice getGUIoptions getOptions getOptionsFileName getOptionsPrefix getPBSext getPBSoptions getWinAct getWinFun getWinVal getYes GT0 importHistory initHistory isWhat jumpHistory lastHistory lisp loadC loadOptions loadOptionsGUI lucent openExamples openFile openUG packList pad0 parseWinFile pause pickCol plotACF plotAsp plotBubbles plotCsum plotDens plotFriedEggs plotSidebars plotTrace presentTalk print promptWriteOptions readList readPBSoptions resetGraph restorePar rmHistory runDemos runExample runExamples saveOptions saveOptionsGUI scalePar selectDir selectFile setFileOption setGUIoptions setOptions setOptionsFileName setOptionsPrefix setPathOption setPBSext setPBSoptions setwdGUI setWidgetColor setWidgetState setWinAct setWinVal show0 showAlert showArgs showHelp showPacks showRes showVignettes sortHistory tcall testAlpha testCol testLty testLwd testWidgets tget tprint tput unpackList updateGUI view viewCode writeList writePBSoptions

Dependencies:XML

Introduction to PBSmodelling

What is PBSmodelling? | What is PBS? | Where is the User's Guide? | Demos

Rendered fromPBSmodellingIntro.Rnwusingutils::Sweave

Last update: 2023-10-24
Started: 2013-04-24

Help page	Topics
Add Arrows to a Plot Using Relative (0:1) Coordinates	addArrows
Add a Label to a Plot Using Relative (0:1) Coordinates	addLabel
Add a Legend to a Plot Using Relative (0:1) Coordinates	addLegend
Calculate Fibonacci Numbers by Several Methods	calcFib
Calculate the Geometric Mean, Allowing for Zeroes	calcGM
Calculate the Minimum of a User-Defined Function	calcMin
Data: Sampled Counts of Quillback Rockfish (Sebastes maliger)	CCA.qbr
Choose and Set a String Item in a GUI	chooseWinVal
Launch a GUI for Project File Deletion	cleanProj
Launch a GUI for File Deletion	cleanWD
Remove all R Objects From a Specified Environment	clearAll
Clear File Extension Associations	clearPBSext
Clear the R Console / Focus on the RGui Window	clearRcon focusRgui
Remove all Current Widget Variables	clearWinVal
Clip a Vector at One or Both Ends	clipVector
Close GUI Window(s)	closeWin
Compile a C File into a Shared Library Object	compileC
Convert and Save a Window Description as a List	compileDescription
Convert Slashes from UNIX to DOS	convSlashes
Create a GUI with a Vector Widget	createVector
Create a GUI Window	createWin
Declare Option Names that Correspond with Widget Names	declareGUIoptions
Execute Action Created by a Widget	doAction
Dot C Support Functions	.cleanLoadC .guiCompileC .guiDyn .guiSource .libName .loadCRunComparison
Dot Convert Functions	.convertMatrixListToDataFrame .convertMatrixListToMatrix .convertMode .convertOldGridToNewGrid .convertParamStrToList .convertParamStrToVector .convertVecToArray
Dot Create Functions	.createTkFont .createWidget .createWidget.button .createWidget.check .createWidget.data .createWidget.droplist .createWidget.entry .createWidget.grid .createWidget.image .createWidget.include .createWidget.label .createWidget.matrix .createWidget.notebook .createWidget.null .createWidget.object .createWidget.object.scrolling .createWidget.progressbar .createWidget.radio .createWidget.slide .createWidget.slideplus .createWidget.spinbox .createWidget.table .createWidget.text .createWidget.vector
Dot GUI Functions	.adjustAllColours .autoConvertMode .buildgrid .catError .catError2 .check.object.exists .do.gui.call .extractData .extractFuns .extractVar .getMatrixListSize .getParamFromStr .getSimilarColour .getValueForWidgetSetup .inCollection .map.add .map.get .map.getAll .map.init .map.set .matrixHelp .packWidgetsIntoGrid .parsegrid .parsemenu .PBSdimnameHelper .searchCollection .setMatrixElement .setWinValHelper .stopWidget .stripComments .stripSlashes .stripSlashesVec .superobject.redraw .superobject.saveValues .table.getvalue .table.setvalue .trimWhiteSpace .validateWindowDescList .validateWindowDescWidgets
Dot History Functions	.createWidget.history .sortHelper .sortHelperActive .sortHelperFile .sortWidget .updateFile .updateHistory .updateHistoryButtons
Dot List Functions	.mergeLists .readList.C .readList.P .readList.P.convertData .writeList.P
PBSmodelling Environment	.PBSmodEnv
Dot Project Functions	.doClean .doCleanWD .getHiddenEnv .getHome .getPrefix .makeCleanVec .mergeLists2 .mergeVectors .optionsNotUpdated .removeFromList .selectCleanBoxes .setOption .showLog .stripExt .tryOpen
Dot Support Functions	.addslashes .dClose .dUpdateDesc .fibC .fibCall .fibClosedForm .fibR .findSquare .forceMode .getArrayPts .initPBSoptions .mapArrayToVec .tclArrayToVector .viewPkgDemo .viewPkgVignette
Dot Talk Functions	.getButton .getButtons .getIndexForSection .getMenus .getSectionNames .getTalkIndexes .nextSlide .parseTalkFile .presentTalkOpenFile .prevSlide .sectiondrop .setsection .slidedrop .startSlide .updateSlide
Dot Widget Definitions	.maxActionSize .pFormatDefs .regex.complex .regex.logical .regex.numeric .tagDefs .tagOptionChecks .widgetDefs
GUI Windows Wrappers	.win.chFile .win.chTest .win.closeALL .win.closeChoice .win.closeSDE .win.makeChoice .win.restoreCWD .win.runExHelperQuit .win.tcall .win.tget .win.tprint
Draw a Linear Barplot on the Current Plot	drawBars
Evaluate a Function Call	evalCall
Expand the Plot Area by Adjusting Margins	expandGraph
Export a Saved History	exportHistory
Search a Character Vector to Find Multiple Patterns	findPat
Find a Prefix Based on Names of Existing Files	findPrefix findSuffix
Locates a program in the PATH environment variable	findProgram
Set the Focus on a Particular Window	focusWin
Generate Test Matrices for plotBubbles	genMatrix
Choose One String Item from a List of Choices	getChoice
Get PBS Options for Widgets	getGUIoptions
Get and Set User Options	.showOptions getOptions setOptions
Get and Set File Name for Saving and Loading of Options	getOptionsFileName setOptionsFileName
Get and Set GUI Prefix of Options Class	getOptionsPrefix setOptionsPrefix
Get Command Associated With File Name Extension	getPBSext
Retrieve A User Option	getPBSoptions
Retrieve the Last Window Action	getWinAct
Retrieve Names of Functions Referenced in a Window	getWinFun
Retrieve Widget Values for Use in R Code	getWinVal
Prompt the User to Choose Yes or No	getYes
Restrict a Numeric Variable to a Positive Value	GT0
Import a History List from a File	importHistory
Create Structures for a New History Widget	addHistory backHistory clearHistory firstHistory forwHistory initHistory jumpHistory lastHistory rmHistory
Identify an Object and Print Information	isWhat
List Objects in .PBSmodEnv Workspace	lisp
Launch a GUI for Compiling and Loading C Code	loadC
Save and Load Options to and from Disk	loadOptions saveOptions saveOptionsAs
Load and Save Options Values to and from a GUI	loadOptionsGUI saveOptionsGUI
Convert Solid Colours to Translucence	lucent
Open Example Files from a Package	openExamples
Open File with Associated Program	openFile
Open Package User Guide	openUG
Pack a List with Objects	packList
Pad Values with Leading Zeroes	pad0
Convert a Window Description File into a List Object	parseWinFile
Pause Between Graphics Displays or Other Calculations	pause
PBS Modelling	PBSmodelling-package PBSmodelling
S4: Project Options Class	PBSoptions-class print,PBSoptions-method show,PBSoptions-method
Pick a Colour From a Palette and get the Hexadecimal Code	pickCol
Plot Autocorrelation Bars From a Data Frame, Matrix, or Vector	plotACF
Construct a Plot with a Specified Aspect Ratio	plotAsp
Construct a Bubble Plot from a Matrix	plotBubbles
Plot Cumulative Sum of Data	plotCsum
Plot Density Curves from a Data Frame, Matrix, or Vector	plotDens
Render a Pairs Plot as Fried Eggs and Beer	plotFriedEggs
Plot Table as Horizontal Sidebars	plotSidebars
Plot Trace Lines from a Data Frame, Matrix, or Vector	plotTrace
Run a Presentation in R	presentTalk
Prompt the User to Write Changed Options	promptWriteOptions
Read a List from an ASCII File	readList
Read PBS Options from an External File	readPBSoptions
Reset par Values for a Plot	resetGraph
Get Actual Parameters from Scaled Values	restorePar
Interactive GUI for R Demos	runDemos
Run a Single GUI Example Included with PBS Modelling	runExample
Run GUI Examples Included with PBS Modelling	runExamples
Scale Parameters to [0,1]	scalePar
Display Dialogue: Select directory	selectDir
Display Dialogue: Open or Save File	selectFile
Set a PBS File Path Option Interactively	setFileOption
Set PBS Options from Widget Values	setGUIoptions
Set a PBS Path Option Interactively	setPathOption
Set Command to Associate with File Name Extension	setPBSext
Set A User Option	setPBSoptions
Browse for Working Directory and Optionally Find Prefix	setwdGUI
Update Widget Color	setWidgetColor
Update Widget State	setWidgetState
Add a Window Action to the Saved Action Vector	setWinAct
Update Widget Values	setWinVal
Convert Numbers into Text with Specified Decimal Places	show0
Display a Message in an Alert Window	showAlert
Display Expected Widget Arguments	showArgs
Display HTML Help Pages for Packages in Browser	showHelp
Show Packages Required But Not Installed	showPacks
Show Results of Expression Represented by Text	showRes
Display Vignettes for Packages	showVignettes
Sort an Active or Saved History	sortHistory
S4: Present Talk Classes	break-class code-class file-class section-class talk-class text-class
Test Various Alpha Transparency Values	testAlpha
Display Colours Available Using a Set of Strings	testCol
Display Line Types Available	testLty
Display Line Widths	testLwd
Display Sample GUIs and their Source Code	testWidgets widgets
Get/Put Objects From/To Temporary Work Environment	tcall tget tprint tput
Unpack List Elements into Variables	unpackList
Update Active GUI With Local Values	updateGUI
Data: Lengths-at-Age for von Bertalanffy Curve	vbdata
Data: Initial Parameters for a von Bertalanffy Curve	vbpars
View First/Last/Random n Elements/Rows of an Object	view
View Package R Code	viewCode
Write a List to a File in PBS Modelling Format	writeList
Write PBS Options to an External File	writePBSoptions

Package: PBSmodelling 2.70.2

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

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)