tget: Get/Print Objects From or Put Objects Into Temporary Work Environment

Description

Get/print objects from or put objects into a temporary work environment called .PBSmodEnv. These objects include .PBSmod, which controls the GUI system.

Usage

tget(x, penv=NULL, tenv=.PBSmodEnv)
tcall(x, penv=NULL, tenv=.PBSmodEnv)
tprint(x, penv=NULL, tenv=.PBSmodEnv)
tput(x, penv=NULL, tenv=.PBSmodEnv)

Value

Objects are retrieved from or sent to the temporary working environment to/from the place where the function(s) are called. Additionally, tcall invisibly returns the object without transferring, which is useful when the object is a function that the user may wish to call, for example, tcall(myfunc)().

Arguments

x: name (with or without quotes) of an object to retrieve or store in the temporary environment.
penv: parent environment, defaults to parent.frame() called from within the function.
tenv: temporary working environment, defaults to .PBSmodEnv.

Author

Rowan Haigh, Pacific Biological Station, Fisheries and Oceans Canada, Nanaimo BC

Details

These accessor functions were developed as a response to the CRAN repository policy statement: “Packages should not modify the global environment (user's workspace).”

There are also wrapper functions called .win.tget, .win.tcall, and .win.tprint that can be used in window description files to launch functions or print objects from the .PBSmodEnv workspace. The wrapper uses getWinAct to get the function (or object) name that a user specifies in the action argument of a widget command.

References

CRAN Repository Policy: https://cran.r-project.org/web/packages/policies.html

Examples

Run this code

if (FALSE) {
local(envir=.PBSmodEnv,expr={
  str(tcall(.PBSmod),2)
})
}

Run the code above in your browser using DataCamp Workspace