plugins/base2/net.sf.basedb.normalizers/trunk/README

Code
Comments
Other
Rev Date Author Line
909 09 Dec 08 jari 1 $Id$
909 09 Dec 08 jari 2
909 09 Dec 08 jari 3 = About `Normalization package for BASE` =
909 09 Dec 08 jari 4
909 09 Dec 08 jari 5 The `Normalization package for BASE (net.sf.basedb.normalization)`
909 09 Dec 08 jari 6 plug-in set is a compilation of normalisers for expression data. See
909 09 Dec 08 jari 7 ``Documentation`` below for further information about the different
1074 15 May 09 jari 8 plug-ins in this package. Common to most of the plug-ins provided with
1074 15 May 09 jari 9 this package is that they work on bioassay sets with either 1-channel
1074 15 May 09 jari 10 and 2-channel data. The algorithms are working on expression values,
1074 15 May 09 jari 11 that is for 2-channel data, ratio ch1/ch2 are used.
909 09 Dec 08 jari 12
909 09 Dec 08 jari 13 `Normalization package for BASE` is free software. See the file
909 09 Dec 08 jari 14 license.txt for copying conditions.
909 09 Dec 08 jari 15
952 06 Feb 09 jari 16 The package was created, and is maintained, by Martin Svensson and
952 06 Feb 09 jari 17 Jari Hakkinen.
909 09 Dec 08 jari 18
909 09 Dec 08 jari 19
909 09 Dec 08 jari 20 == Downloading ==
909 09 Dec 08 jari 21
909 09 Dec 08 jari 22 `Normalization package for BASE` can be obtained from
909 09 Dec 08 jari 23
909 09 Dec 08 jari 24   http://baseplugins.thep.lu.se/wiki/PluginDownload
909 09 Dec 08 jari 25
909 09 Dec 08 jari 26
909 09 Dec 08 jari 27 = Installation =
909 09 Dec 08 jari 28
909 09 Dec 08 jari 29 Installation instructions can be found in the 'INSTALL' file.
909 09 Dec 08 jari 30
909 09 Dec 08 jari 31
909 09 Dec 08 jari 32 = Documentation =
909 09 Dec 08 jari 33
909 09 Dec 08 jari 34
909 09 Dec 08 jari 35 == Average normalization ==
909 09 Dec 08 jari 36
925 17 Dec 08 jari 37 This plug-in scales the expression values for an assay with a factor,
928 18 Dec 08 jari 38 ''S'', equal to the ratio of either i) the geometric mean of the
928 18 Dec 08 jari 39 expression values of all spots in the bioassay set divided by the
928 18 Dec 08 jari 40 assay average, or ii) a user defined value divided by the assay
928 18 Dec 08 jari 41 average.
909 09 Dec 08 jari 42
925 17 Dec 08 jari 43 The new expression values will become ''S'' times the original
925 17 Dec 08 jari 44 expression value.
1087 19 May 09 martin 45 The user can choose between using geometric or arithmetic mean when 
1087 19 May 09 martin 46 calculating the averages.
925 17 Dec 08 jari 47
909 09 Dec 08 jari 48 Background subtraction and proper filtration have to be done before
925 17 Dec 08 jari 49 running this plug-in.
909 09 Dec 08 jari 50
909 09 Dec 08 jari 51
952 06 Feb 09 jari 52 == qQuantile normalization ==
952 06 Feb 09 jari 53
1074 15 May 09 jari 54 The current implementation of qQuantile normalization supports only
1074 15 May 09 jari 55 1-channel arrays.
952 06 Feb 09 jari 56
952 06 Feb 09 jari 57 The qQuantile normalization is inspired by the 'Cubic Spline'
952 06 Feb 09 jari 58 normalization in Illumina Beadstudio and the work by Workman et al.,
952 06 Feb 09 jari 59 http://www.pubmedcentral.nih.gov/articlerender.fcgi?tool=pubmed&pubmedid=12225587
952 06 Feb 09 jari 60
1074 15 May 09 jari 61 In qQuantile normalization, all assays (including the target) are
1074 15 May 09 jari 62 sorted in increasing intensity. The sorted list of probe intensities
1074 15 May 09 jari 63 are partitioned into q groups, and each of theses q groups are
1074 15 May 09 jari 64 adjusted (normalized) with the corresponding target group. After
1074 15 May 09 jari 65 normalization the intensity distribution of each assay will be
1074 15 May 09 jari 66 approximately the same as the target distribution. q is calculated as
1074 15 May 09 jari 67 q=max(10,min(100,target_size/10)). The program will stop if the number
1074 15 May 09 jari 68 of well defined expression values in the target or any of the assays
1074 15 May 09 jari 69 in the set is smaller than q.
952 06 Feb 09 jari 70
1074 15 May 09 jari 71 The target is defined by selecting a subset of the assays in the
1074 15 May 09 jari 72 bioassay set, and the target expression values are the medians of
1074 15 May 09 jari 73 probe intensities over the bioassay set. Probes with no well defined
1074 15 May 09 jari 74 measurements in the bioassay set are simply ignored in target
1074 15 May 09 jari 75 calculation.
1074 15 May 09 jari 76
1074 15 May 09 jari 77 Since the normalization calculations are based on geometric means and
1074 15 May 09 jari 78 performed in log space the intensities must be positive and larger
1074 15 May 09 jari 79 than 0. Rather than expecting the user of qQuantile normalization to
1074 15 May 09 jari 80 remove such intensity the underlying algorithm silently ignores zero
1074 15 May 09 jari 81 and negative intensities.
1074 15 May 09 jari 82
2173 12 Dec 13 jari 83 The bioassay set to be normalized must be non-logarithmic values since this
1177 16 Oct 09 jari 84 plug-in will log all values before performing the normalization.
1177 16 Oct 09 jari 85
1074 15 May 09 jari 86 Background subtraction and proper filtration should be done on the
1074 15 May 09 jari 87 bioassay set before running this plug-in.
1074 15 May 09 jari 88
1074 15 May 09 jari 89
926 17 Dec 08 jari 90 == Quantile normalization ==
909 09 Dec 08 jari 91
926 17 Dec 08 jari 92 In quantile normalization each assay data is sorted in ascending
926 17 Dec 08 jari 93 expression value order and added to a matrix as columns. The matrix
926 17 Dec 08 jari 94 rows will contain mixed probes (also known as reporters or genes)
926 17 Dec 08 jari 95 decided by their rank. For each row in the matrix, the expression
2173 12 Dec 13 jari 96 values are replaced with the row average value (geometric or
2173 12 Dec 13 jari 97 arithmetic selectable by user). Finally, each assay is
926 17 Dec 08 jari 98 reordered into its original order to retain a standard expression
926 17 Dec 08 jari 99 matrix were each row represents one probe. Assays are not mixed.
909 09 Dec 08 jari 100
1051 06 May 09 jari 101 Background subtraction and proper filtration should be done on the
909 09 Dec 08 jari 102 bioassay set before running this plug-in. The bioassay set must not
909 09 Dec 08 jari 103 contain any missing values.
909 09 Dec 08 jari 104
2173 12 Dec 13 jari 105
2173 12 Dec 13 jari 106
733 01 Aug 08 martin 107 ----------------------------------------------------------------------
733 01 Aug 08 martin 108 {{{
909 09 Dec 08 jari 109 Copyright (C) 2008 Jari Häkkinen, Martin Svensson
1051 06 May 09 jari 110 Copyright (C) 2009 Jari Häkkinen
733 01 Aug 08 martin 111
909 09 Dec 08 jari 112 This file is part of the Normalizers plug-in package for BASE
909 09 Dec 08 jari 113 (net.sf.based.normalizers). The package is available at
909 09 Dec 08 jari 114 http://baseplugins.thep.lu.se/ BASE main site is
909 09 Dec 08 jari 115 http://base.thep.lu.se/
733 01 Aug 08 martin 116
733 01 Aug 08 martin 117 This is free software; you can redistribute it and/or
733 01 Aug 08 martin 118 modify it under the terms of the GNU General Public License
910 09 Dec 08 jari 119 as published by the Free Software Foundation; either version 3
733 01 Aug 08 martin 120 of the License, or (at your option) any later version.
733 01 Aug 08 martin 121
733 01 Aug 08 martin 122 The software is distributed in the hope that it will be useful,
733 01 Aug 08 martin 123 but WITHOUT ANY WARRANTY; without even the implied warranty of
733 01 Aug 08 martin 124 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
733 01 Aug 08 martin 125 GNU General Public License for more details.
733 01 Aug 08 martin 126
733 01 Aug 08 martin 127 You should have received a copy of the GNU General Public License
910 09 Dec 08 jari 128 along with this program. If not, see <http://www.gnu.org/licenses/>.
733 01 Aug 08 martin 129 }}}