nwsOpenWs                package:nws                R Documentation

_C_r_e_a_t_e _a_n_d _O_w_n _a _n_e_t_W_o_r_k_S_p_a_c_e

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

     Create and own a netWorkSpace, if it does not already exist. If
     the  netWorkSpace already exists, but no one owns it, then caller
     claims  ownership of the netWorkspace.  If the netWorkSpace
     already exists  and someone already claimed the ownership of it,
     then caller simply makes connection to the netWorkspace.

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

     ## S4 method for signature 'nwsServer':
     nwsOpenWs(.Object, wsName, space=NULL, ...)

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

 .Object: a nwsServer class object

  wsName: name of the netWorkSpace to be created

   space: a netWorkSpace class object

     ...: optional arguments related to the persistent state of a
          netWorkSpace

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

     If the 'space' argument is not provided, 'nwsOpenWs' creates a
     shared  netWorkSpace with the name 'wsName' on the server
     represented by  '.Object'. Otherwise, use the existing
     netWorkSpace object provided by the 'space' argument. 

     The optional argument 'persistent' is a logical value indicating 
     whether the shared netWorkSpace is persistent or not. If the
     netWorkSpace  is persisent ('persistent=TRUE'), then the
     netWorkSpace is not deleted when the owner of the shared
     netWorkSpace  exits. Otherwise, the netWorkSpace is deleted when
     its owner exits.

_S_e_e _A_l_s_o:

     'nwsUseWs'

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

     ## Not run: 
     # example 1
     nwss <- nwsServer()
     ws <- nwsOpenWs(nwss, "nws example")

     # example 2
     xs <- nwsOpenWs(nwss, wsName='nws example', space=ws)

     # example 3
     ys <- nwsOpenWs(nwss, "persistent space", persistent=TRUE)
     ## End(Not run)

