getDatasetNames.ggobi         package:Rggobi         R Documentation

_G_e_t _t_h_e _n_a_m_e_s _o_r _i_n_d_e_x _o_f _t_h_e _d_a_t_a_s_e_t_s _i_n _a _g_g_o_b_i _i_n_s_t_a_n_c_e

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

     The 'getDatasetNames.ggobi' is a method for  obtaining the names
     of the different datasets  within a ggobi instance. Occassionally
     it is also useful to map the name  of one of these datasets to is
     position or index.

     'datasetIndex.ggobi' does this, but it is used infrequently given
     the introduction of the 'ggobiDataset' class and methods (e.g.
     'getDatasetReference.ggobi') for obtaining references to datasets
     that are position/order invariant. This is also a function that is
     typically used by other functions in the package and not directly
     called by users of the package.

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

     getDatasetNames.ggobi(.gobi=getDefaultGGobi())
     datasetIndex.ggobi(.data, .gobi=getDefaultGGobi())

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

   .data: the names of one or more dataset whose indices are to be
          determined.

   .gobi: the identifier for the ggobi instance whose datasets are to
          be queried. This should be an object of class 'ggobi' or else
          an integer identifying the ggobi instance by position in the
          list of all ggobis.

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

     The name of a dataset is defined in a variety of different ways
     depending on the format of the input file, data, etc.

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

     'getDatasetNames.ggobi' returns a character vector containing the
     names of the datasets.

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

     'names.ggobi' 'getDatasetReference.ggobi'

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

        g <- ggobi(system.file("data", "flea.xml", package="Rggobi"), args="-noinit")
        names(g)
        getDatasetNames.ggobi(g)

