Changeset 1577

Timestamp:

Oct 14, 2008, 3:49:49 PM (14 years ago)

Author:

Peter

Message:

docs

File:

• trunk/yat/normalizer/QuantileNormalizer.h (modified) (2 diffs)

trunk/yat/normalizer/QuantileNormalizer.h

@@ -33 +33 @@
      \brief Perform quantile normalization
 
+     After a quantile normalization each column has the same
+     distribution of data (the quantiles are the same). Also, within
+     each column the rank of an element is not changed. The
+     distribution that each column follows is determined by taking the
+     average across columns, i.e., the largest element in each column
+     will be equal to the average of the largest elements. The 2nd
+     largest element in each column will be equal to the average of
+     the 2nd largest element in eacc column et cetera.
+
+     There is currently no weighted version of QuantileNormalizer
+
      \since New in yat 0.5
    */
@@ -39 +50 @@
   public:
     /**
-       The \a matrix is normalized by sorting each column, replacing
-       each value with the average across rows, and undo the sorting
-       in step 1. This results in a Matrix \a result in which each
-       column has the same distribution of data, and the rank of an
-       element within a column is the same as in \a matrix.
+       \brief perform the quantile normalization.
+
+       It is possible to normalize "in place"; it is permissible for
+       \a matrix and \a result to reference to the same Matrix.
 
        \note dimensions of \a matrix and \a result must match.