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

Code
Comments
Other
Rev Date Author Line
1097 28 May 09 martin 1 <?xml version="1.0" encoding="UTF-8" ?>
1097 28 May 09 martin 2 <!-- 
1097 28 May 09 martin 3   $Id$
1097 28 May 09 martin 4
1097 28 May 09 martin 5   Copyright (C) 2009 Martin Svensson
1097 28 May 09 martin 6
1097 28 May 09 martin 7   This file is part of FTP extension for BASE.
1097 28 May 09 martin 8   Available at http://baseplugins.thep.lu.se/
1097 28 May 09 martin 9
1097 28 May 09 martin 10   BASE is free software; you can redistribute it and/or
1097 28 May 09 martin 11   modify it under the terms of the GNU General Public License
1097 28 May 09 martin 12   as published by the Free Software Foundation; either version 3
1097 28 May 09 martin 13   of the License, or (at your option) any later version.
1097 28 May 09 martin 14
1097 28 May 09 martin 15   BASE is distributed in the hope that it will be useful,
1097 28 May 09 martin 16   but WITHOUT ANY WARRANTY; without even the implied warranty of
1097 28 May 09 martin 17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1097 28 May 09 martin 18   GNU General Public License for more details.
1097 28 May 09 martin 19
1097 28 May 09 martin 20   You should have received a copy of the GNU General Public License
1097 28 May 09 martin 21   along with this program; if not, write to the Free Software
1097 28 May 09 martin 22   Foundation, Inc., 59 Temple Place - Suite 330,
1097 28 May 09 martin 23   Boston, MA  02111-1307, USA.
1097 28 May 09 martin 24 -->
1097 28 May 09 martin 25
1097 28 May 09 martin 26 <extensions xmlns="http://base.thep.lu.se/extensions.xsd">
1238 07 Sep 10 nicklas 27   <about>
1238 07 Sep 10 nicklas 28     <name>Illumina extensions</name>
1448 02 Nov 11 nicklas 29     <version>1.8-dev</version>
1385 02 Sep 11 martin 30     <copyright>BASE development team</copyright>
1238 07 Sep 10 nicklas 31     <email>basedb-users@lists.sourceforge.net</email>
1385 02 Sep 11 martin 32     <url>http://baseplugins.thep.lu.se/wiki/net.sf.basedb.illumina</url>  
1386 06 Sep 11 nicklas 33     <description>
1386 06 Sep 11 nicklas 34       This package contains plug-ins and extensions for the Illumina platform.
1386 06 Sep 11 nicklas 35     </description>
2283 13 Mar 14 nicklas 36     <min-base-version>3.3.0</min-base-version>
1238 07 Sep 10 nicklas 37   </about>
1385 02 Sep 11 martin 38   <plugin-definition id="Installer">
1385 02 Sep 11 martin 39     <about>
1385 02 Sep 11 martin 40       <name>Illumina plug-in package installer</name>
1385 02 Sep 11 martin 41       <description>
1385 02 Sep 11 martin 42         This plug-in will install required platforms, data files types, etc. that
1385 02 Sep 11 martin 43         are required to use the Illumina plug-ins. Start the installation by selecting this 
1385 02 Sep 11 martin 44         plug-in from the list at Administrate -> Plugins -> Definitions. Then click on the 
1385 02 Sep 11 martin 45         'Run plugin' button.
1385 02 Sep 11 martin 46       </description>      
1385 02 Sep 11 martin 47     </about>    
1385 02 Sep 11 martin 48     <plugin-class>net.sf.basedb.illumina.install.Install</plugin-class>
1385 02 Sep 11 martin 49   </plugin-definition>
1385 02 Sep 11 martin 50   <plugin-definition id="ExpressionBackgroundCorrection">
1385 02 Sep 11 martin 51     <about>
1385 02 Sep 11 martin 52       <name>Illumina expression background correction</name>
1385 02 Sep 11 martin 53       <description>    
1385 02 Sep 11 martin 54         This plug-in will remove a per-slide global background from all 
1385 02 Sep 11 martin 55         spots. The background is calculated from a set of negative control 
1386 06 Sep 11 nicklas 56         spots on the array.
1385 02 Sep 11 martin 57         Each assay is treated separately, i.e., no samples are combined 
1385 02 Sep 11 martin 58         together. All calculations are made on the current bioassay data 
1385 02 Sep 11 martin 59         implying that this plug-in should be used early in analysis and before 
1386 06 Sep 11 nicklas 60         background spots are removed.
1385 02 Sep 11 martin 61         A spot is considered to be a negative control spot if it has an 
1386 06 Sep 11 nicklas 62         ''Control group name'' exactly matching the string ''negative''.
1385 02 Sep 11 martin 63         There is one parameter to set that specifies how background 
1385 02 Sep 11 martin 64         intensities should be calculated. Allowed values are median or mean, 
1385 02 Sep 11 martin 65         i.e. the background is either the median or the mean of the negative 
1386 06 Sep 11 nicklas 66         control spots on the array.
1385 02 Sep 11 martin 67         The expression of the background probes is optionally saved to a 
1385 02 Sep 11 martin 68         file. The default is not to save the expression matrix but this can be 
1385 02 Sep 11 martin 69         changed during job configuration.    
1385 02 Sep 11 martin 70       </description>      
1385 02 Sep 11 martin 71     </about>    
1385 02 Sep 11 martin 72     <plugin-class>net.sf.basedb.illumina.plugins.BackgroundCorrection</plugin-class>
1385 02 Sep 11 martin 73   </plugin-definition>
1385 02 Sep 11 martin 74   <plugin-definition id="BeadSummaryImporter">
1385 02 Sep 11 martin 75     <about>
1385 02 Sep 11 martin 76       <name>Illumina Bead Summary importer</name>
1385 02 Sep 11 martin 77       <description>
1385 02 Sep 11 martin 78         Raw data importer for Illumina bead summary files. This plug-in can import data from one 
1385 02 Sep 11 martin 79         or more related bead summary files that are part of the same array but different stripes.
1385 02 Sep 11 martin 80       </description>      
1385 02 Sep 11 martin 81     </about>    
1385 02 Sep 11 martin 82     <plugin-class>net.sf.basedb.illumina.plugins.BeadSummaryImporter</plugin-class>
1385 02 Sep 11 martin 83   </plugin-definition>
1385 02 Sep 11 martin 84   <plugin-definition id="BgxFeatureImporter">
1385 02 Sep 11 martin 85     <about>
1385 02 Sep 11 martin 86       <name>Illumina BGX feature importer</name>
1385 02 Sep 11 martin 87       <description>
1385 02 Sep 11 martin 88         Plugin that imports features from a Illumina BGX-file. 
1385 02 Sep 11 martin 89         Both compressed(gzip) and uncompressed files are supported. 
1385 02 Sep 11 martin 90         None of the mappings for the [Controls] section are configurable. 
1386 06 Sep 11 nicklas 91         These are set like follows:
1386 06 Sep 11 nicklas 92         Identify features by->FEATURE_IDReporter ID->\\Probe_Id\\Feature ID->\\Array_Address_Id\\
1385 02 Sep 11 martin 93         Reg exp for data header is preconfigured to 'Probe_Id\\tArray_Address_Id.*'
1385 02 Sep 11 martin 94       </description>
1385 02 Sep 11 martin 95     </about>
1385 02 Sep 11 martin 96     <plugin-class>net.sf.basedb.illumina.plugins.BgxFeatureImporter</plugin-class>
1385 02 Sep 11 martin 97   </plugin-definition>
1385 02 Sep 11 martin 98   <plugin-definition id="BgxReporterImporter">
1385 02 Sep 11 martin 99     <about>
1385 02 Sep 11 martin 100       <name>Illumina BGX reporter importer</name>
1385 02 Sep 11 martin 101       <description>
1385 02 Sep 11 martin 102         Imports reporter annotation from Illumina BGX files. This importer is 
1385 02 Sep 11 martin 103         based on the regular reporter importer and has the same features and functions. 
1385 02 Sep 11 martin 104         It supports both compressed and uncompressed BGX files. File format configurations 
1385 02 Sep 11 martin 105         made for this plug-in applies to the [Probes] section only. Column mappings for the 
1385 02 Sep 11 martin 106         [Controls] section can't be configured. Some controls appear more than one time 
1385 02 Sep 11 martin 107         in the [Controls] section. If the they have different values for the any of the 
1385 02 Sep 11 martin 108         Reporter_Group_Name, Reporter_Group_Id and/or Reporter_Composite_Map columns the values 
1385 02 Sep 11 martin 109         are merged with a ; as separator.
1385 02 Sep 11 martin 110       </description>
1385 02 Sep 11 martin 111     </about>    
1385 02 Sep 11 martin 112     <plugin-class>net.sf.basedb.illumina.plugins.BgxReporterImporter</plugin-class>
1385 02 Sep 11 martin 113   </plugin-definition>  
1385 02 Sep 11 martin 114   <plugin-definition id="DetectionPvalueCalculation">
1385 02 Sep 11 martin 115     <about>
1385 02 Sep 11 martin 116       <name>Illumina detection P-value calculation</name>
1385 02 Sep 11 martin 117       <description>
1385 02 Sep 11 martin 118         This plug-in implements BeadStudio like detection P-value calculations 
1386 06 Sep 11 nicklas 119         for Illumina expression data.
1385 02 Sep 11 martin 120         The plug-in will _always_ base the detection P-value calculation on 
1385 02 Sep 11 martin 121         raw data values, i.e., the mean raw intensity for the different 
1385 02 Sep 11 martin 122         signals. By default the calculations are based on negative controls 
1385 02 Sep 11 martin 123         available in the root bioassay set for the current analysis 
1385 02 Sep 11 martin 124         branch. The user may change this to only use negative controls in the 
1386 06 Sep 11 nicklas 125         current bioassay set.
3477 03 Sep 15 jari 126         A data value is considered to be a negative control value if
3477 03 Sep 15 jari 127         it has a "Control group name" exactly matching the string
3477 03 Sep 15 jari 128         "negative".
1385 02 Sep 11 martin 129         The detection P-value plug-in does not filter the assays, it provides 
1385 02 Sep 11 martin 130         the detection P-values usable in a filter step after running this 
1386 06 Sep 11 nicklas 131         plug-in.
1386 06 Sep 11 nicklas 132         Parameters
1385 02 Sep 11 martin 133         - The plug-in requires input of array type since detection P-value are 
1386 06 Sep 11 nicklas 134         calculated differently depending on array type.
1385 02 Sep 11 martin 135         - Users may select to use negative controls in the current bioassay set 
1385 02 Sep 11 martin 136         only. The default behaviour is to use all negative controls in the 
1386 06 Sep 11 nicklas 137         root bioassay set for the current bioassay set.
1385 02 Sep 11 martin 138         - A cut off parameter is available to exclude outliers within 
1385 02 Sep 11 martin 139         the negative controls. The `cutoff` defines the acceptable negative 
1385 02 Sep 11 martin 140         control signal range 
1385 02 Sep 11 martin 141         $median-MAD*cutoff &lt; I &lt; median+MAD*cutoff$ 
1386 06 Sep 11 nicklas 142         where $MAD$ is the median absolute deviation.
1386 06 Sep 11 nicklas 143         Implementation details
1385 02 Sep 11 martin 144         Each assay is treated separately, i.e., no samples are combined 
1385 02 Sep 11 martin 145         together. All calculations are made on the raw bead-type level data, 
1385 02 Sep 11 martin 146         i.e., on the average expression value for each bead type and raw data 
1385 02 Sep 11 martin 147         is always used irrespective when in analysis the detection P-value is 
1386 06 Sep 11 nicklas 148         calculated.
1386 06 Sep 11 nicklas 149         Pvalue calculation for whole genome arrays:
1385 02 Sep 11 martin 150         For all signals $i$ calculate the detection P-value as 
1385 02 Sep 11 martin 151         $Pvalue = 1-R/N$ where $R$ is the rank of the signal $i$ relative to the 
1386 06 Sep 11 nicklas 152         negative controls and $N$ is the number of negative controls.
1385 02 Sep 11 martin 153         Pvalue calculation for others array types (DASL, miRNA, VeraCode DASL, 
1386 06 Sep 11 nicklas 154         and Focused Arrays):
1385 02 Sep 11 martin 155         For all signals $i$ calculate the detection P-value as 
1385 02 Sep 11 martin 156         $Pvalue = 1/2 - 1/2 * erf( [i-AvgControl]/StdControl/sqrt(2) )$ where 
1385 02 Sep 11 martin 157         $AvgControl$ is the average intensity of the negative controls, 
1385 02 Sep 11 martin 158         $StdControl$ is the standard deviation of the the negative controls, 
1385 02 Sep 11 martin 159         and $erf$ is the error function 
1385 02 Sep 11 martin 160         (http://mathworld.wolfram.com/Erf.html). The error function is used 
1385 02 Sep 11 martin 161         for arguments within the range (-4,4). To save CPU cycles, the function 
1385 02 Sep 11 martin 162         value for arguments outside this range is set to -1 and 1, 
1386 06 Sep 11 nicklas 163         respectively.
1385 02 Sep 11 martin 164         More details about this plug-in is found at the URL
3477 03 Sep 15 jari 165         Please send feedback to the email-address
1385 02 Sep 11 martin 166       </description>
1385 02 Sep 11 martin 167     </about>    
1385 02 Sep 11 martin 168     <plugin-class>net.sf.basedb.illumina.plugins.DetectionPValue</plugin-class>
1385 02 Sep 11 martin 169   </plugin-definition>
1385 02 Sep 11 martin 170   <plugin-definition id="SnpRootBioAssaysetCreator">
1385 02 Sep 11 martin 171     <about>
1385 02 Sep 11 martin 172       <name>Illumina SNP root bioassayset creator</name>
1385 02 Sep 11 martin 173       <description>
1385 02 Sep 11 martin 174         Creates a root bioassay set from Illumina SNP data. This plug-in works 
1385 02 Sep 11 martin 175         only if all raw bioassays has the same array design and SNP split data files 
1385 02 Sep 11 martin 176         are present. The root bioassayset is created by copying values from the data files 
1386 06 Sep 11 nicklas 177         as follows:
1386 06 Sep 11 nicklas 178          * Channel 1 = GType (AA = 1.0, AB = 0.0, BB = -1.0, NC = null)
1386 06 Sep 11 nicklas 179          * Channel 2 = Log R Ratio
1385 02 Sep 11 martin 180          * Channel 3 = B Allele Freq
1385 02 Sep 11 martin 181       </description>
1385 02 Sep 11 martin 182     </about>
1385 02 Sep 11 martin 183     <plugin-class>net.sf.basedb.illumina.plugins.SnpIntensityCalculator</plugin-class>
1385 02 Sep 11 martin 184   </plugin-definition>
1385 02 Sep 11 martin 185   <plugin-definition id="SnpRawDataImporter">
1385 02 Sep 11 martin 186     <about>
1385 02 Sep 11 martin 187       <name>Illumina SNP raw data importer</name>
1385 02 Sep 11 martin 188       <description>
1385 02 Sep 11 martin 189         This plug-in is used to import raw data for Illumina SNP from a tab separated text file. The plug-in can be 
1385 02 Sep 11 martin 190         executed both from the list of raw bioassays and from within an experiment. In the 
1385 02 Sep 11 martin 191         last case the imported data will be associated with the experiment
1385 02 Sep 11 martin 192       </description>
1385 02 Sep 11 martin 193     </about>  
1385 02 Sep 11 martin 194     <plugin-class>net.sf.basedb.illumina.plugins.SnpRawDataImporter</plugin-class>
1385 02 Sep 11 martin 195   </plugin-definition>
1385 02 Sep 11 martin 196   <plugin-definition id="SnpReporterImporter">
1385 02 Sep 11 martin 197     <about>
1385 02 Sep 11 martin 198       <name>Illumina SNP reporter importer</name>
1385 02 Sep 11 martin 199       <description>
1385 02 Sep 11 martin 200         Imports reporters from SNP manifest files. This importer works exactly 
1385 02 Sep 11 martin 201         as the regular reporter importer and has the same features.
1385 02 Sep 11 martin 202       </description>
1385 02 Sep 11 martin 203     </about>
1385 02 Sep 11 martin 204     <plugin-class>net.sf.basedb.illumina.plugins.SnpReporterImporter</plugin-class>
1385 02 Sep 11 martin 205   </plugin-definition>
1097 28 May 09 martin 206   <extension 
1133 18 Jun 09 martin 207     id="net.sf.basedb.illumina.extensions.overviewplots.illuminaPlots" 
1097 28 May 09 martin 208     extends="net.sf.basedb.clients.web.bioassayset.overviewplots"
1097 28 May 09 martin 209     >
1097 28 May 09 martin 210     <index>20</index>
1097 28 May 09 martin 211     <about>
1097 28 May 09 martin 212       <name>Illumina overview plot</name>
1135 23 Jun 09 martin 213       <description>Generates overview plot for Illumina expression data.</description>
1097 28 May 09 martin 214     </about>
1097 28 May 09 martin 215     <action-factory>
1097 28 May 09 martin 216       <factory-class>net.sf.basedb.illumina.extensions.plot.PlotFactory</factory-class>
1097 28 May 09 martin 217       <parameters>
1141 24 Jun 09 martin 218         <width>800</width>
1141 24 Jun 09 martin 219         <height>600</height>        
1097 28 May 09 martin 220       </parameters>
1097 28 May 09 martin 221     </action-factory>
1097 28 May 09 martin 222   </extension>
1386 06 Sep 11 nicklas 223   <extension 
1386 06 Sep 11 nicklas 224     id="net.sf.basedb.illumina.extensions.bgxvalidator"
1386 06 Sep 11 nicklas 225     extends="net.sf.basedb.core.filehandler.validator"
1386 06 Sep 11 nicklas 226     >
1386 06 Sep 11 nicklas 227     <about>
1386 06 Sep 11 nicklas 228       <name>BGX file validator</name>
1386 06 Sep 11 nicklas 229       <description>
1386 06 Sep 11 nicklas 230         Validator and metadata extractor implementation for Illumina BGX files.
1386 06 Sep 11 nicklas 231         It will parse the start of the file until the [Probes] section is found
1386 06 Sep 11 nicklas 232         and then extract the number of probes + controls and set that as the
1386 06 Sep 11 nicklas 233         number of features on the array design.
1386 06 Sep 11 nicklas 234       </description>
1386 06 Sep 11 nicklas 235     </about>
1386 06 Sep 11 nicklas 236     <index>1</index>
1386 06 Sep 11 nicklas 237     <action-factory>
1386 06 Sep 11 nicklas 238       <factory-class>net.sf.basedb.illumina.filehandler.BgxValidationFactory</factory-class>
1386 06 Sep 11 nicklas 239     </action-factory>
1386 06 Sep 11 nicklas 240   </extension>
1386 06 Sep 11 nicklas 241   <extension 
1386 06 Sep 11 nicklas 242     id="net.sf.basedb.illumina.extensions.snpvalidator"
1386 06 Sep 11 nicklas 243     extends="net.sf.basedb.core.filehandler.validator"
1386 06 Sep 11 nicklas 244     >
1386 06 Sep 11 nicklas 245     <about>
1386 06 Sep 11 nicklas 246       <name>SNP manifest validator</name>
1386 06 Sep 11 nicklas 247       <description>
1386 06 Sep 11 nicklas 248         Validator and metadata extractor implementation for Illumina SNP manifest files.
1386 06 Sep 11 nicklas 249         It will parse the start of the file until the [Assay] section is found
1386 06 Sep 11 nicklas 250         and then extract the SNP Count value and set that as the number of features
1386 06 Sep 11 nicklas 251         on the array design.
1386 06 Sep 11 nicklas 252       </description>
1386 06 Sep 11 nicklas 253     </about>
1386 06 Sep 11 nicklas 254     <index>1</index>
1386 06 Sep 11 nicklas 255     <action-factory>
1386 06 Sep 11 nicklas 256       <factory-class>net.sf.basedb.illumina.filehandler.SnpCvsValidationFactory</factory-class>
1386 06 Sep 11 nicklas 257     </action-factory>
1386 06 Sep 11 nicklas 258   </extension>
1386 06 Sep 11 nicklas 259   
3477 03 Sep 15 jari 260 </extensions>

Generated on Tue Nov 21 03:42:59 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)