shortenGeneDescription       package:siggenes       R Documentation

_S_h_o_r_t_e_n _t_h_e _G_e_n_e _D_e_s_c_r_i_p_t_i_o_n

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

     Shorten the entries of the column of a data frame containing the
     genes associated with the SNPs for which the data frame comprises
     annotations. Typically used in combination with, i.e. either
     within or after an application of, 'buildSNPannotation'

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

       shortenGeneDescription(dat, colname = "Gene", max.length = 2, 
          sep = "///", add.ldots = TRUE)

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

     dat: a data frame. Typically, the output of 'buildSNPannotation'

 colname: character string comprising the name of the column of 'dat'
          containing the gene description

max.length: integer specifying the maximum number of genes associated
          with the respective SNP that should be stored in the data
          frame. By default, the first two genes are retained. 
          Shortened entries are marked by '...' at the end of the
          entries, when 'add.ldots = TRUE'

     sep: character string specifying the separation symbol between the
          different genes

add.ldots: should '...' be added at the entries which are shortened?

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

     the same data frame as 'dat' with shortened entries in the column
     of 'dat' named 'colname'

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

     Holger Schwender, holger.schw@gmx.de

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

     'buildSNPannotation', 'link.genes', 'link.siggenes', 'sam2html'

