netWorkSpace {nws} | R Documentation |
NetWorkSpaces provides a framework to coordinate R programs. NetWorkSpaces objects represent a generalized workspace or environment. Two or more R programs communicate data by storing it in and retrieving it from the NetWorkSpace object.
Objects can be created by calls of the form
netWorkSpace(wsName, ...)
or
new("netWorkSpace", wsName, ...)
where '...' can be one or more of the following named arguments:
wsName
serverInfo
serverInfo
or managedServerInfo
. If not
specified, will get the return value of getServer
.useUse
useUse=FALSE
, which means ownership will be claimed.serverWrap
server
"nwsServer"
representation of the server that this netWorkSpace connects to.wsName
"character"
representation of this netWorkSpace's name.
signature(.Object = "netWorkSpace")
: netWorkSpace class constructor.nwsFetch
signature(.Object = "netWorkSpace")
: fetch a value of a workspace variable.nwsFetchTry
signature(.Object = "netWorkSpace")
: try to fetch a value of a workspace variable.nwsFind
signature(.Object = "netWorkSpace")
: find a value of a workspace variable.nwsFindTry
signature(.Object = "netWorkSpace")
: try to find a value of a workspace variable.nwsStore
signature(.Object = "netWorkSpace")
: store a value into a workspace variable.nwsFetchFile
signature(.Object = "netWorkSpace")
: fetch a value of a workspace variable and write it to a file.nwsFetchTryFile
signature(.Object = "netWorkSpace")
: try to fetch a value of a workspace variable and write it to a file.nwsFindFile
signature(.Object = "netWorkSpace")
: find a value of a workspace variable and write it to a file.nwsFindTryFile
signature(.Object = "netWorkSpace")
: try to find a value of a workspace variable and write it to a file.nwsStoreFile
signature(.Object = "netWorkSpace")
: store data from a file into a workspace variable.nwsIFetch
signature(.Object = "netWorkSpace")
:
create a function that acts as a destructive iterator over the values of the specified variable.nwsIFetchTry
signature(.Object = "netWorkSpace")
:
create a function that acts as a destructive iterator over the values of the specified variable.nwsIFind
signature(.Object = "netWorkSpace")
:
create a function that acts as a non-destructive iterator over the values of the specified variable.nwsIFindTry
signature(.Object = "netWorkSpace")
:
create a function that acts as a non-destructive iterator over the values of the specified variable.nwsClose
signature(.Object = "netWorkSpace")
: close the connection to the NWS server.nwsDeclare
signature(.Object = "netWorkSpace")
: declare the mode of a workspace variable.nwsDeleteVar
signature(.Object = "netWorkSpace")
: delete a variable from a workspace.nwsListVars
signature(.Object = "netWorkSpace")
: list all variables in a workspace.ServerObject
signature(.Object = "netWorkSpace")
: return the associated NwsServer object.nwsVariable
signature(.Object = "netWorkSpace")
: create an Active Binding for a NetWorkSpace VariablenwsWsName
signature(.Object = "netWorkSpace")
: return the name of the workspace.
The constructor still supports the serverHost
and port
arguements, but as of release 2.0, they are deprecated and will be
removed in 4.0.
The legacy descriptions are:
serverHost
: host name of the server this netWorkSpace will be connected to. By default, local machine is used.
port
: port number of the server this netWorkSpace will be
connected to. Default port number is 8765.
If the user specifies both one or more deprecated options and a serverInfo object, the deprecated option(s) will be ignored.
## Not run: # To create a new workspace with the name "my space" use: ws = netWorkSpace('my space') # To create a new workspace called "my space2" on nws server # running on port 8245 on machine zeus: ws2 = netWorkSpace(wsName='my space2', serverInfo=serverInfo(host='zeus', port=8245)) ## End(Not run)