alleleSummary          package:GeneticsBase          R Documentation

_S_u_m_m_a_r_y _o_f _a_l_l_e_l_e _i_n_f_o_r_m_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Summary of allele information.

_U_s_a_g_e:

     alleleSummary(object, 
                   by = NULL, 
                   confidence = 0.95, 
                   alpha = 1 - confidence, 
                   show = TRUE, 
                   verbose = FALSE, 
                   includeOverall = FALSE, 
                   omitRepeats = TRUE, 
                   ...)

_A_r_g_u_m_e_n_t_s:

  object: geneSet object  

      by: optional column name, by which the summary is desired.
          Default is NULL.  

confidence: confidence intervals of Genotype frequencies within each
          marker (default is 95%) 

   alpha: Type -1 error rate = (1- confidence)

    show: No longer used  

 verbose: Logical value (TRUE/FALSE), showing whether every 50th marker
          should be printed, default = FALSE 

includeOverall: logical value (TRUE/FALSE) indicating whether overall
          summary is also needed, default = FALSE  

omitRepeats: logical value (TRUE/FALSE) indicating whether Gene name
          and marker name should be printed repeatedly for each
          Genotype, default = TRUE 

     ...: Optional arguments

_A_u_t_h_o_r(_s):

     Nitin Jain nitin.jain@pfizer.com

_E_x_a_m_p_l_e_s:

     library(GeneticsBase)
     data(CAMP)

     temp <- alleleSummary(CAMP)

     print(temp) # display
     txt(temp, filename="alleleSummary.txt")   # txt file
     html(temp, filename="alleleSummary.html") # html file
     latex(temp, filename="alleleSummary.tex") # latex file

