SplitXDataFrame-class        package:IRanges        R Documentation

_S_p_l_i_t _X_D_a_t_a_F_r_a_m_e

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

     Represents an 'XDataFrame' split along some factor. Internally a
     list of 'XDataFrame' instances and extends 'TypedList'. Asserts
     all elements have the same number and names of columns.

_A_c_c_e_s_s_o_r_s:

     In the following code snippets, 'x' is a 'SplitXDataFrame'.

      'dim(x)': Get the two element integer vector indicating the
          number of rows and columns over the entire dataset.

      'dimnames(x)': Get the list of two character vectors, the first
          holding the rownames (possibly 'NULL') and the second the
          column names.


_C_o_n_s_t_r_u_c_t_o_r:


      'SplitXDataFrame(...)': Concatenates the 'XDataFrame' instances
          in '...' into a new 'SplitXDataFrame'. Note that all
          arguments should have the same number and names of columns.

_C_o_e_r_c_i_o_n:

     In the following code snippets, 'x' is a 'SplitXDataFrame'.

      'as(from, "XDataFrame")': Coerces a 'SplitXDataFrame' to an
          'XDataFrame' by combining the rows of the elements. This
          essentially unsplits the 'XDataFrame'.

      'unlist(x, recursive = TRUE, use.names = TRUE)': Same as above,
          except specifying 'use.names' to 'FALSE' drops the row names.
          'recursive' is ignored.

      'as.data.frame(x, row.names=NULL, optional=FALSE, ...)': Unsplits
          the 'XDataFrame' and coerces it to a 'data.frame', with the
          rownames specified in 'row.names'. The 'optional' argument is
          ignored.


_N_o_t_e:

     The 'RangedData' drove the development of this class. It is not
     clear if it is of general use and might disappear.

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

     Michael Lawrence

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

     'XDataFrame', 'RangedData', which uses a 'SplitXDataFrame' to
     split the data by the spaces.

