describe.ggobi            package:Rggobi            R Documentation

_P_r_o_v_i_d_e _a _d_e_s_c_r_i_p_t_i_o_n _o_f _o_n_e _o_r _m_o_r_e _g_g_o_b_i _i_n_s_t_a_n_c_e_s

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

     This returns a description of each of the ggobi instances
     identified in the arguments. These should be specified as objects
     of class 'ggobi'. The result describes the current state of the
     ggobi instance, including its datasets and displays.

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

     describe.ggobi(..., full = FALSE)

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

     ...: any number of 'ggobi' objects. If no values are specfied, all
          GGobi instances are used.

    full: (currently ignored) a logical value indicating whether the
          full or brief description should be returned for each ggobi
          instance.

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

     This returns a list with as many elements as there are ggobi
     instances specfied. Each element is a list of length $3$ with
     elements: 

datasets: a named list describing each dataset within this ggobi
          instance. Each description consists of

     _n_a_m_e a character vector containing the name of the dataset and the
          (primary) file from which it was read.

     _d_i_m_s the number of records and variables in the dataset.

     _f_o_r_m_a_t the data format of the file from which the data was read
          (e.g. XML, ASCII,  binary, MySQL, etc.)

     _v_a_r_i_a_b_l_e_s a character vector giving the names of the variables

     _a_u_x_i_l_l_a_r_y_F_i_l_e_s any additional files that were read when processing
          the  primary file (e.g. links in the XML file, .col and .rows
          files in ASCII format, etc.) 

displays: a list describing each of the displays within

   ggobi: the ggobi instance from which this description was obtained

_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:

     'ggobi' 'getGGobi'

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

      ggobi(args=c("-noinit", "-verbose", "-xml", system.file("data", "COI.xml", package="Rggobi")))
      describe.ggobi()

