getEdges.ggobi            package:Rggobi            R Documentation

_C_o_n_n_e_c_t_i_o_n_s _b_e_t_w_e_e_n _p_o_i_n_t_s _i_n _a _G_G_o_b_i _d_a_t_a_s_e_t

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

     These functions allow the user to establish and query connections
     between points in a GGobi instance and use this information to
     show edge connections on displays.

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

     getEdges.ggobi(edgeset = 1, .data = NULL, .gobi=getDefaultGGobi())
     setEdges.ggobi(src, dest, edgeset, .gobi=getDefaultGGobi())

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

 edgeset: an identifier for the dataset within the GGobi instance,
          given as an index or an object of class the 'ggobiDataset'

   .data: an identifier for the dataset within the GGobi instance,
          given as an index or an object of class the 'ggobiDataset'

   .gobi: an identifier for the GGobi instance which can be omitted if
          '.data' is a 'ggobiDataset' object. Otherwise this should be
          an integer identifying the GGobi instance or a 'ggobi'
          object. 

     src: a vector identifying the source of the edges by index or a 2
          column matrix giving the source and destination

    dest: a vector giving the indeces of the destination nodes of the
          edges used together with 'x' 

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

_V_a_l_u_e:

     A matrix giving the edge pairs before the call.

_Q_u_e_s_t_i_o_n:

     Should no edges return NULL or an empty matrix?

_N_o_t_e:

     The edge mechanism in GGobi is very powerful and supports a very
     general form of linking. As a result, simple uses may appear
     complex. The idea with this interface is to try to hide the
     complexity. However, you are advised to read the GGobi and RGGobi
     manuals to get a better understanding of edges and  linking.

_A_u_t_h_o_r(_s):

     Duncan Temple Lang

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://www.ggobi.org>

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

     'createEdgeData.ggobi' 'setDisplayEdges.ggobi'

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

     ## Not run: 
     #XXX
      ggobi(file.path(ggobi.home(), "datasets", "snetwork.xml")) # Find ggobi.home
      getEdges.ggobi(2, 1)
      getEdges.ggobi(2)
     ## End(Not run)

