netWorkSpace               package:nws               R Documentation

_N_e_t_W_o_r_k_S_p_a_c_e_s _O_b_j_e_c_t_s

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

     NetWorkSpaces provides a framework to coordinate R programs.
     NetWorkSpaces objects represent a generalized workspace or
     environment.  Two or more R programs communicate data by storing
     it in and retrieving it from the NetWorkSpace object.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form 
       'netWorkSpace(wsName, serverHost, port, useUse, serverWrap,
     ...)' 
      or 
      'new("netWorkSpace", wsName, serverHost, port, useUse,
     serverWrap, ...)'.

     '_w_s_N_a_m_e' name of the netWorkSpace to be created.

     '_s_e_r_v_e_r_H_o_s_t' host name of the server this netWorkSpace will be
          connected to. By default, local machine is used.

     '_p_o_r_t' port number of the server this netWorkSpace will be
          connected to. Default port number is 8765.

     '_u_s_e_U_s_e' a logical value indicating whether ownership will be
          claimed for this netWorkSpace. By default, 'useUse=FALSE',
          which means ownership will be claimed.

     '_s_e_r_v_e_r_W_r_a_p' a netWorkSpaces server object. Reuse an existing
          server connection, instead of creating a new server
          connection.

_S_l_o_t_s:


     '_s_e_r_v_e_r' Object of class '"nwsServer"' representation of the
          server that this netWorkSpace connects to.

     '_w_s_N_a_m_e' Object of class '"character"' representation of this
          netWorkSpace's name.

_M_e_t_h_o_d_s:


     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "netWorkSpace")': netWorkSpace
          class constructor.

     '_n_w_s_F_e_t_c_h' 'signature(.Object = "netWorkSpace")': fetch a value of
          a workspace variable.

     '_n_w_s_F_e_t_c_h_T_r_y' 'signature(.Object = "netWorkSpace")': try to fetch
          a value of a workspace variable.

     '_n_w_s_F_i_n_d' 'signature(.Object = "netWorkSpace")': find a value of a
          workspace variable.

     '_n_w_s_F_i_n_d_T_r_y' 'signature(.Object = "netWorkSpace")': try to find a
          value of a workspace variable.

     '_n_w_s_S_t_o_r_e' 'signature(.Object = "netWorkSpace")': store a value
          into a workspace variable.

     '_n_w_s_F_e_t_c_h_F_i_l_e' 'signature(.Object = "netWorkSpace")': fetch a
          value of a workspace variable and write it to a file.

     '_n_w_s_F_e_t_c_h_T_r_y_F_i_l_e' 'signature(.Object = "netWorkSpace")': try to
          fetch a value of a workspace variable and write it to a file.

     '_n_w_s_F_i_n_d_F_i_l_e' 'signature(.Object = "netWorkSpace")': find a value
          of a workspace variable and write it to a file.

     '_n_w_s_F_i_n_d_T_r_y_F_i_l_e' 'signature(.Object = "netWorkSpace")': try to
          find a value of a workspace variable and write it to a file.

     '_n_w_s_S_t_o_r_e_F_i_l_e' 'signature(.Object = "netWorkSpace")': store data
          from a file into a workspace variable.

     '_n_w_s_I_F_e_t_c_h' 'signature(.Object = "netWorkSpace")': create a
          function that acts as a destructive iterator over the values
          of the specified variable.

     '_n_w_s_I_F_e_t_c_h_T_r_y' 'signature(.Object = "netWorkSpace")': create a
          function that acts as a destructive iterator over the values
          of the specified variable.

     '_n_w_s_I_F_i_n_d' 'signature(.Object = "netWorkSpace")': create a
          function that acts as a non-destructive iterator over the
          values of the specified variable.

     '_n_w_s_I_F_i_n_d_T_r_y' 'signature(.Object = "netWorkSpace")': create a
          function that acts as a non-destructive iterator over the
          values of the specified variable.

     '_n_w_s_C_l_o_s_e' 'signature(.Object = "netWorkSpace")': close the
          connection to the NWS server.

     '_n_w_s_D_e_c_l_a_r_e' 'signature(.Object = "netWorkSpace")': declare the
          mode of a workspace variable.

     '_n_w_s_D_e_l_e_t_e_V_a_r' 'signature(.Object = "netWorkSpace")': delete a
          variable from a workspace.

     '_n_w_s_L_i_s_t_V_a_r_s' 'signature(.Object = "netWorkSpace")': list all
          variables in a workspace.

     '_S_e_r_v_e_r_O_b_j_e_c_t' 'signature(.Object = "netWorkSpace")': return the
          associated NwsServer object.

     '_n_w_s_V_a_r_i_a_b_l_e' 'signature(.Object = "netWorkSpace")': create an
          Active Binding for a NetWorkSpace Variable

     '_n_w_s_W_s_N_a_m_e' 'signature(.Object = "netWorkSpace")': return the name
          of the workspace.

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

     ## Not run: 
     # To create a new workspace with the name "my space" use:
     ws = netWorkSpace('my space')

     # To create a new workspace called "my space2" on nws server 
     # running on port 8245 on machine zeus:
     ws2 = netWorkSpace(wsName='my space2', serverHost='zeus', port=8245)
     ## End(Not run)

