plugins/base2/net.sf.basedb.normalizers/trunk/META-INF/extensions.xml

Code
Comments
Other
Rev Date Author Line
1410 19 Oct 11 nicklas 1 <?xml version="1.0" encoding="UTF-8" ?>
2176 12 Dec 13 jari 2 <!--
2176 12 Dec 13 jari 3     $Id$
2176 12 Dec 13 jari 4
2176 12 Dec 13 jari 5     Copyright (C) 2011 Nicklas Nordborg
2176 12 Dec 13 jari 6     Copyright (C) 2013 Jari Häkkinen, Olle Månsson
2176 12 Dec 13 jari 7
2176 12 Dec 13 jari 8     This file is part of the Normalizers plug-in package for BASE
2176 12 Dec 13 jari 9     (net.sf.based.normalizers). The package is available at
2176 12 Dec 13 jari 10     http://baseplugins.thep.lu.se/ BASE main site is
2176 12 Dec 13 jari 11     http://base.thep.lu.se/
2176 12 Dec 13 jari 12
2176 12 Dec 13 jari 13     This is free software; you can redistribute it and/or modify it
2176 12 Dec 13 jari 14     under the terms of the GNU General Public License as published by
2176 12 Dec 13 jari 15     the Free Software Foundation; either version 3 of the License, or
2176 12 Dec 13 jari 16     (at your option) any later version.
2176 12 Dec 13 jari 17
2176 12 Dec 13 jari 18     The software is distributed in the hope that it will be useful,
2176 12 Dec 13 jari 19     but WITHOUT ANY WARRANTY; without even the implied warranty of
2176 12 Dec 13 jari 20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2176 12 Dec 13 jari 21     General Public License for more details.
2176 12 Dec 13 jari 22
2176 12 Dec 13 jari 23     You should have received a copy of the GNU General Public License
2176 12 Dec 13 jari 24     along with this program. If not, see <http://www.gnu.org/licenses/>.
2176 12 Dec 13 jari 25 -->
2176 12 Dec 13 jari 26
1410 19 Oct 11 nicklas 27 <extensions xmlns="http://base.thep.lu.se/extensions.xsd">
1410 19 Oct 11 nicklas 28   <about>
1410 19 Oct 11 nicklas 29     <name>Normalization plug-ins package</name>
1410 19 Oct 11 nicklas 30     <description>
1410 19 Oct 11 nicklas 31       This package is a compilation of normalisers for expression data. 
1410 19 Oct 11 nicklas 32       Common to most of the plug-ins is that they work on bioassay sets 
1410 19 Oct 11 nicklas 33       with either 1-channel or 2-channel data. The algorithms are working 
1410 19 Oct 11 nicklas 34       on expression values, that is for 2-channel data, ratio ch1/ch2 are 
1410 19 Oct 11 nicklas 35       used.
1410 19 Oct 11 nicklas 36     </description>
2176 12 Dec 13 jari 37     <version>1.1-beta2</version>
2284 13 Mar 14 nicklas 38     <min-base-version>3.3.0</min-base-version>
1410 19 Oct 11 nicklas 39     <copyright>BASE development team</copyright>
1410 19 Oct 11 nicklas 40     <email>basedb-users@lists.sourceforge.net</email>
1410 19 Oct 11 nicklas 41     <url>http://baseplugins.thep.lu.se/wiki/net.sf.basedb.normalizers</url>
1410 19 Oct 11 nicklas 42   </about>
1410 19 Oct 11 nicklas 43
1410 19 Oct 11 nicklas 44   <plugin-definition id="AverageNormalization">
1410 19 Oct 11 nicklas 45     <about>
1410 19 Oct 11 nicklas 46       <name>Average normalization</name>
1410 19 Oct 11 nicklas 47       <description>
1410 19 Oct 11 nicklas 48         This plug-in scales the expression values for an assay with a
1410 19 Oct 11 nicklas 49         factor, "S", equal to the ratio of either:
1410 19 Oct 11 nicklas 50         
1410 19 Oct 11 nicklas 51         i) the geometric mean of the expression values of all spots in the 
1410 19 Oct 11 nicklas 52         bioassay set divided by the assay average, or 
1410 19 Oct 11 nicklas 53         
1410 19 Oct 11 nicklas 54         ii) a user defined value divided by the assay average.
1410 19 Oct 11 nicklas 55         
1410 19 Oct 11 nicklas 56         The new expression values will become "S" times the original 
2165 09 Dec 13 olle 57         expression value. Background subtraction and proper filtration 
1410 19 Oct 11 nicklas 58         have to be done before running this plug-in. 
1410 19 Oct 11 nicklas 59         
1410 19 Oct 11 nicklas 60         This plug-in supports 1-channel and 2-channel data.
1410 19 Oct 11 nicklas 61       </description>      
1410 19 Oct 11 nicklas 62     </about>    
1410 19 Oct 11 nicklas 63     <plugin-class>net.sf.basedb.plugins.AverageNormalization</plugin-class>
1410 19 Oct 11 nicklas 64     <settings>
1410 19 Oct 11 nicklas 65       <property name="everyone-use">1</property>
1410 19 Oct 11 nicklas 66     </settings>
1410 19 Oct 11 nicklas 67   </plugin-definition>
1410 19 Oct 11 nicklas 68
1410 19 Oct 11 nicklas 69   <plugin-definition id="QuantileNormalization">
1410 19 Oct 11 nicklas 70     <about>
1410 19 Oct 11 nicklas 71       <name>Quantile normalization</name>
1410 19 Oct 11 nicklas 72       <description>
1410 19 Oct 11 nicklas 73         In quantile normalization each assay data is sorted in ascending 
1410 19 Oct 11 nicklas 74         expression value order and added to a matrix as columns. The matrix 
1410 19 Oct 11 nicklas 75         rows will contain mixed probes (also known as reporters or genes) 
1410 19 Oct 11 nicklas 76         decided by their rank. For each row in the matrix, the expression 
2176 12 Dec 13 jari 77         values are replaced with the row average value (geometric or 
2176 12 Dec 13 jari 78         arithmetic selectable by user). Finally, each assay is 
1410 19 Oct 11 nicklas 79         is reordered into its original order to retain a standard 
2165 09 Dec 13 olle 80         expression matrix where each row represents one probe. Assays are 
1410 19 Oct 11 nicklas 81         not mixed.
1410 19 Oct 11 nicklas 82         
1410 19 Oct 11 nicklas 83         Background subtraction and proper filtration should be done on the 
1410 19 Oct 11 nicklas 84         bioassay set before running this plug-in. The bioassay set must not 
1410 19 Oct 11 nicklas 85         contain any missing values.
1410 19 Oct 11 nicklas 86         
1410 19 Oct 11 nicklas 87         This plug-in supports 1-channel and 2-channel data.
1410 19 Oct 11 nicklas 88       </description>      
1410 19 Oct 11 nicklas 89     </about>    
1410 19 Oct 11 nicklas 90     <plugin-class>net.sf.basedb.plugins.QuantileNormalization</plugin-class>
1410 19 Oct 11 nicklas 91     <settings>
1410 19 Oct 11 nicklas 92       <property name="everyone-use">1</property>
1410 19 Oct 11 nicklas 93     </settings>
1410 19 Oct 11 nicklas 94   </plugin-definition>
1410 19 Oct 11 nicklas 95
1410 19 Oct 11 nicklas 96   <plugin-definition id="qQuantileNormalization">
1410 19 Oct 11 nicklas 97     <about>
1410 19 Oct 11 nicklas 98       <name>qQuantile normalization</name>
1410 19 Oct 11 nicklas 99       <description>
1410 19 Oct 11 nicklas 100         The qQuantile normalization is inspired by the 'Cubic Spline' normalization 
1410 19 Oct 11 nicklas 101         in Illumina Beadstudio and the work by Workman et al., 
1410 19 Oct 11 nicklas 102         http://www.pubmedcentral.nih.gov/articlerender.fcgi?tool=pubmed&amp;pubmedid=12225587
1410 19 Oct 11 nicklas 103
1410 19 Oct 11 nicklas 104         In qQuantile normalization, all assays (including the target) are sorted in 
1410 19 Oct 11 nicklas 105         increasing intensity. The sorted list of probe intensities are partitioned 
1410 19 Oct 11 nicklas 106         into q groups, and each of theses q groups are adjusted (normalized) with the 
1410 19 Oct 11 nicklas 107         corresponding target group. After normalization the intensity distribution of 
1410 19 Oct 11 nicklas 108         each assay will be approximately the same as the target distribution. q is 
1410 19 Oct 11 nicklas 109         calculated as q=max(10,min(100,target_size/10)). The program will stop if the 
1410 19 Oct 11 nicklas 110         number of well defined expression values in the target or any of the assays 
1410 19 Oct 11 nicklas 111         in the set is smaller than q.
1410 19 Oct 11 nicklas 112
1410 19 Oct 11 nicklas 113         The target is defined by selecting a subset of the assays in the bioassay set, 
1410 19 Oct 11 nicklas 114         and the target expression values are the medians of probe intensities over the 
1410 19 Oct 11 nicklas 115         bioassay set. Probes with no well defined measurements in the bioassay set are 
1410 19 Oct 11 nicklas 116         simply ignored in target calculation.
1410 19 Oct 11 nicklas 117
1410 19 Oct 11 nicklas 118         Since the normalization calculations are based on geometric means and performed 
1410 19 Oct 11 nicklas 119         in log space the intensities must be positive and larger than 0. Rather than 
1410 19 Oct 11 nicklas 120         expecting the user of qQuantile normalization to remove such intensity the 
1410 19 Oct 11 nicklas 121         underlying algorithm silently ignores zero and negative intensities.
1410 19 Oct 11 nicklas 122
1410 19 Oct 11 nicklas 123         Background subtraction and proper filtration should be done on the bioassay set 
1410 19 Oct 11 nicklas 124         before running this plug-in.
1410 19 Oct 11 nicklas 125
1410 19 Oct 11 nicklas 126         Only 1-channel data is supported.
1410 19 Oct 11 nicklas 127       </description>      
1410 19 Oct 11 nicklas 128     </about>
1410 19 Oct 11 nicklas 129     <plugin-class>net.sf.basedb.plugins.qQuantileNormalization</plugin-class>
1410 19 Oct 11 nicklas 130     <settings>
1410 19 Oct 11 nicklas 131       <property name="deprecated">1</property>
1410 19 Oct 11 nicklas 132     </settings>
1410 19 Oct 11 nicklas 133   </plugin-definition>
1410 19 Oct 11 nicklas 134
1410 19 Oct 11 nicklas 135   <plugin-definition id="RankInvariantNormalization">
1410 19 Oct 11 nicklas 136     <about>
1410 19 Oct 11 nicklas 137       <name>Rank invariant normalization</name>
1410 19 Oct 11 nicklas 138       <description>
2165 09 Dec 13 olle 139         The development of this plug-in is still in progress.
2165 09 Dec 13 olle 140         
2165 09 Dec 13 olle 141         This plug-in currently only supports 1-channel data.
1410 19 Oct 11 nicklas 142       </description>      
1410 19 Oct 11 nicklas 143     </about>    
1410 19 Oct 11 nicklas 144     <plugin-class>net.sf.basedb.plugins.RankInvariantNormalization</plugin-class>
1410 19 Oct 11 nicklas 145   </plugin-definition>
1410 19 Oct 11 nicklas 146
2176 12 Dec 13 jari 147 </extensions>