getGENETITLE         package:annotationTools         R Documentation

_F_i_n_d _g_e_n_e _t_i_t_l_e_s

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

     Takes a vector of probe set identifiers and an annotation table
     and retrieves the corresponding gene titles.

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

     getGENETITLE(ps, annot, diagnose = FALSE, TITLEcol = 14, noTITLEsymbol = NA, noTITLEprovidedSymbol = "---", sep = " /// ")

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

      ps: character vector containing the probe sets identifiers.

   annot: annotation table (data frame) where each row is a record and
          each column is an annotation field.

diagnose: logical. If TRUE, 3 (logical) vectors used for diagnostic
          purpose are returned in addition to the annotation. If FALSE
          (default) only the annotation is returned.

TITLEcol: column in annotation table containing the gene titles.

noTITLEsymbol: character string to be used in output list 'genetitle'
          if no gene title is found or provided in the annotation
          table.

noTITLEprovidedSymbol: character string used in annotation table and
          indicating missing gene title.

     sep: character string used in annotation table to separate
          multiple gene titles.

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

     This function can be used with Affymetrix annotation files (e.g.
     'HG-U133_Plus_2_annot.csv'). It retrieves the gene titles
     corresponding to particular probe set identifiers.

     Gene titles are returned as elements of list 'genetitle'. If
     multiple gene titles are provided for 'ps[i]' (with 'sep'
     separating gene titles in the annotation table), a vector
     containing all gene titles is returned as the 'i-th' element of
     list 'genetitle'.

     The default values for 'TITLEcol', 'noTITLEsymbol',
     'noTITLEprovidedSymbol' and 'sep' are chosen to suit the format of
     Affymetrix annotation files. However, these options can be set to
     look up any annotation table, provided the probe set identifiers
     are in the first column and occur only once.

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

genetitle: list of length 'length(ps)' the 'i'-th element of which
          contains the gene title for 'ps[i]'.

   empty: logical vector of length 'length(ps)'. 'empty[i]' is TRUE if
          'ps[i]' is empty or NA.

 noentry: locial vector of length 'length(ps)'. 'noentry[i]' is TRUE if
          'ps[i]' cannot be found in the first column of the annotation
          table.

 notitle: locial vector of length 'length(ps)'. 'noid[i]' is TRUE if
          'genetitle[i]==noTITLEprovidedSymbol' is TRUE.

_N_o_t_e:

     'getANNOTATION' provides a more flexible solution to be used with
     arbitrary annotation tables.

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

     Alexandre Kuhn, alexandre.kuhn@isb-sib.ch

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

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

     'getANNOTATION'

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

     ##example Affymetrix annotation file and its location
     annotationFile<-'HG-U133_Plus_2_annot_part.csv'
     dataDirectory<-system.file('data',package='annotationTools')

     ##load annotation file
     annotation<-read.csv(paste(dataDirectory,annotationFile,sep='/'),colClasses='character')

     ##get gene titles
     myPS<-c('117_at','1007_s_at','1552288_at',NA,'xyz_at')
     getGENETITLE(myPS,annotation)

     ##track origin of annotation failure for the 3 last probe set IDs
     getGENETITLE(myPS,annotation,diagnose=TRUE)

