calcGC                 package:HELP                 R Documentation

_C_a_l_c_u_l_a_t_e _G_C _p_e_r_c_e_n_t

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

     Function to calculate GC percent from a nucleotide sequence input

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

     calcGC(x, ...)

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

       x: characters containing nucleotide sequence (ex: '"ATCGGAA"')
          or an object of class 'ExpressionSet' 

     ...: Other arguments passed to methods: '\item{allow}'{ vector of
          characters specifying what other characters to allow in
          sequence (default is '"N"') } 

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

     Returns a numerical value (from '0' to '1') indicating the C+G
     content of the sequence, corresponding to the fraction of
     (C+G)/(A+T+C+G...). A value of 'NA' is returned if the function
     encounters an error that prevents proper calculation of GC
     percent.

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

     Reid F. Thompson (rthompso@aecom.yu.edu)

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

     'calcGC-methods', 'calcTm'

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

     #demo(pipeline,package="HELP")

     calcGC("AAAACGCG")
     calcGC(sequence="cXgXcXgXcXgX",allow="X")

