reverseComplement         package:Biostrings         R Documentation

_S_e_q_u_e_n_c_e _r_e_v_e_r_s_i_n_g _a_n_d _c_o_m_p_l_e_m_e_n_t_i_n_g

_D_e_s_c_r_i_p_t_i_o_n:

     These functions can reverse a BString, DNAString or RNAString
     object and complement each base of a DNAString object.

_U_s_a_g_e:

       reverse(x)
       complement(x)
       reverseComplement(x)

_A_r_g_u_m_e_n_t_s:

       x: A 'BString' (or derived) object or a 'BStringViews' object
          for 'reverse'. A 'DNAString' object or a 'BStringViews'
          object with a 'DNAString' subject for 'complement' and
          'reverseComplement'. 

_D_e_t_a_i_l_s:

     Given an object 'x' of class BString, DNAString or RNAString,
     'reverse(x)' returns an object of the same class where letters in
     'x' are reordered in the reverse ordered. If 'x' is a DNAString
     object, 'complement(x)' returns an object where each base in 'x'
     is "complemented" i.e. A, C, G, T are replaced by T, G, C, A
     respectively. Letters belonging to the "IUPAC extended genetic
     alphabet" are also replaced by their complement (M <-> K, R <-> Y,
     S <-> S, V <-> B, W <-> W, H <-> D, N <-> N) and the gap symbol
     (-) is unchanged. 'reverseComplement(x)' is equivalent to
     'reverse(complement(x))' but is faster and more memory efficient.

_V_a_l_u_e:

     An object of the same class and length as the original object.

_A_u_t_h_o_r(_s):

     H. Pages

_S_e_e _A_l_s_o:

_E_x_a_m_p_l_e_s:

       reverseComplement(DNAString("ACGT-YN-"))