nwsListVars               package:nws               R Documentation

_n_e_t_W_o_r_k_S_p_a_c_e _C_l_a_s_s _M_e_t_h_o_d

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

     List variables in a netWorkSpace.

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

     ## S4 method for signature 'netWorkSpace':
     nwsListVars(.Object, wsName='', showDataFrame=FALSE)

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

 .Object: a netWorkSpace class object

  wsName: name of the netWorkSpace

showDataFrame: show result in data frame or string

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

     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 (default value),
     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.

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

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

