nws (version 1.7.0.1)

nwsListVars: List Variables in a netWorkSpace

Description

List variables in a netWorkSpace.

Usage

"nwsListVars"(.Object, wsName='', showDataFrame=FALSE)

Arguments

.Object

a netWorkSpace class object.

wsName

character string specifying the name of the netWorkSpace.

showDataFrame

logical flag specifying whether to show result in data frame or string.

Details

Return listing of variables in the netWorkSpace with the name passed by wsName argument. If wsName is empty, then return variables in the netWorkSpace represented by .Object.

The return values from nwsListVars can be represented in a string or a data frame. If showDataFrame is set to FALSE (the default), then the listing is returned in a string. To see list output clearly, use: write(nwsListVars(.Object), stdout())

If showDataFrame is set to TRUE, then the listing is returned in a data frame with these fields: Variables, NumValues, NumFetchers, NumFinders, and Mode.

Examples

## Not run: 
# # example 1
# ws <- netWorkSpace('nws example')
# write(nwsListVars(ws), stdout())
# ## End(Not run)