nwsListWss                package:nws                R Documentation

_L_i_s_t _A_l_l _n_e_t_W_o_r_k_S_p_a_c_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     List all netWorkSpaces in the netWorkSpaces server.

_U_s_a_g_e:

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

_A_r_g_u_m_e_n_t_s:

 .Object: a nwsServer class object

showDataFrame: show result in data frame or string

_D_e_t_a_i_l_s:

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

     If 'showDataFrame' is set to 'FALSE', then 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, showDataFrame=FALSE), stdout())'

_E_x_a_m_p_l_e_s:

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

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

     $"2"
     [1] "my space"

     $"3"
     [1] "other space"
     ## End(Not run)

