nwsListWss-methods: List All netWorkSpaces

In nws: R functions for NetWorkSpaces and Sleigh

Description

List all netWorkSpaces in the netWorkSpaces server.

Usage

## S4 method for signature 'nwsServer'
nwsListWss(.Object, showDataFrame=FALSE)

Arguments

.Object	a nwsServer class object
showDataFrame	show result in data frame or string

Details

By default, showDataFrame is set to FALSE, which means the return value is a text string containing a list of workspaces in the netWorkSpaces server. To see list output clearly, use:
write(nwsListWss(.Object), stdout())

If showDataFrame is set to TRUE, then the return value is a data frame with these columns: Owned, Name, Owner, Persistent, NumVariables, and Variables.

Examples

## Not run: 
# example 1
nwss <- nwsServer()
ws1 <- nwsOpenWs(nwss, 'my space')
ws2 <- nwsOpenWs(nwss, 'other space')
write(nwsListWss(nwss), stdout())

# example 2
# retrieve all workspace names
df <- nwsListWss(nwss, showDataFrame=TRUE)
df$Name
$"1"
[1] "__default"

$"2"
[1] "my space"

$"3"
[1] "other space"

## End(Not run)

nws documentation built on May 2, 2019, 8:51 a.m.