Similarity-class            package:maDB            R Documentation

_C_l_a_s_s "_S_i_m_i_l_a_r_i_t_y"

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

     This class holds information about the similarity between a vector
     and another one (or the rows or columns of a numerical matrix). An
     instance of this class will be returned as the result of the
     'dbSearchSimilarPattern' function. So this object holds then
     information about the similarity (calculated with one of the
     different distance measurement functions (pearson, euclidian,
     spearman)) between a template gene pattern and a set of other gene
     expression or regulation patterns.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     The function 'dbSearchSimilarPattern' returns an instance of this
     class.

_S_l_o_t_s:

     '_d_i_s_t_a_n_c_e_s': Object of class '"numeric"', this vector represents
          the distance (similarity) between numerical vectors.

     '_d_i_s_t_a_n_c_e._m_e_t_r_i_c': Object of class '"character"', the distance
          metric used to calculate the similarity.

     '_d_a_t_a': Object of class '"matrix"', the data matrix containing the
          values with which the template was compared.

     '_t_e_m_p_l_a_t_e': Object of class '"numeric"', the template vector.

     '_t_e_m_p_l_a_t_e._i_d': Object of class '"character"', the id of the
          template (if no custom template was used).

_M_e_t_h_o_d_s:

     _g_e_t_D_a_t_a 'signature(object = "Similarity")': returns the data
          matrix.

     _g_e_t_D_i_s_t_a_n_c_e_s 'signature(object = "Similarity")': returns the
          distances.

     _p_l_o_t 'signature(x = "Similarity")': plots the template and the 5
          top matching vectors (see 'plotSimilarity' for more options).

     _p_r_i_n_t 'signature(x = "Similarity")': generic print function for
          the class Similarity.

     _s_o_r_t 'signature(x = "Similarity")': sorts the data ascending or
          descending according to the distance.

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

     Johannes Rainer

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

     'dbSearchSimilarPattern' 'plotSimilarity'

