plugins/base2/net.sf.basedb.illumina/trunk/README_PluginDetails

Code
Comments
Other
Rev Date Author Line
1038 14 Apr 09 jari 1 $Id$
1038 14 Apr 09 jari 2
1038 14 Apr 09 jari 3 == Introduction ==
1038 14 Apr 09 jari 4
1038 14 Apr 09 jari 5 There are many plug-ins in the Illumina plug-in package for BASE. This
1038 14 Apr 09 jari 6 file gives detailed information on some of the contributed plug-ins.
1038 14 Apr 09 jari 7
1038 14 Apr 09 jari 8
1218 29 Mar 10 jari 9
1203 11 Mar 10 jari 10 == Illumina expression background correction plug-in ==
1203 11 Mar 10 jari 11
1203 11 Mar 10 jari 12 This plug-in will remove a per-slide global background from all
1203 11 Mar 10 jari 13 spots. The background is calculated from a set of negative control
1203 11 Mar 10 jari 14 spot on the array. See implementation details below for details.
1203 11 Mar 10 jari 15
1203 11 Mar 10 jari 16 === Parameters ===
1203 11 Mar 10 jari 17
1207 19 Mar 10 jari 18 There is one parameter to set that specifies how background
1207 19 Mar 10 jari 19 intensities should be calculated. Allowed values are median or mean,
1207 19 Mar 10 jari 20 i.e. the background is either the median or the mean of the negative
1207 19 Mar 10 jari 21 control spots on the array.
1203 11 Mar 10 jari 22
1207 19 Mar 10 jari 23 The expression of the background probes is optionally saved to a
1207 19 Mar 10 jari 24 file. The default is not to save the expression matrix but this can be
1207 19 Mar 10 jari 25 changed during job configuration.
1207 19 Mar 10 jari 26
1203 11 Mar 10 jari 27 === Implementation details ===
1203 11 Mar 10 jari 28
1203 11 Mar 10 jari 29 Each assay is treated separately, i.e., no samples are combined
1203 11 Mar 10 jari 30 together. All calculations are made on the current bioassay data
1203 11 Mar 10 jari 31 implying that this plug-in should be used early in analysis and before
1203 11 Mar 10 jari 32 background spots are removed.
1203 11 Mar 10 jari 33
3477 03 Sep 15 jari 34 A spot is considered to be a negative control spot if it has a
1203 11 Mar 10 jari 35 ''Control group name'' exactly matching the string ''negative''.
1203 11 Mar 10 jari 36
1203 11 Mar 10 jari 37
1203 11 Mar 10 jari 38
1038 14 Apr 09 jari 39 == Illumina detection P-value calculation ==
1038 14 Apr 09 jari 40
1038 14 Apr 09 jari 41 This plug-in implements !BeadStudio like detection P-value calculations
1038 14 Apr 09 jari 42 for Illumina expression data (see
1113 08 Jun 09 jari 43 http://www.genomecenter.ucdavis.edu/expression_analysis/documents/illumina_normalization_081201.pdf)
1038 14 Apr 09 jari 44 on detection P-values.
1038 14 Apr 09 jari 45
1038 14 Apr 09 jari 46 The plug-in will ''always'' base the detection P-value calculation on
1038 14 Apr 09 jari 47 raw data values, ''i.e.'', the mean raw intensity for the different
1168 29 Sep 09 jari 48 signals. By default the calculations are based on negative controls
1168 29 Sep 09 jari 49 available in the root bioassay set for the current analysis
1168 29 Sep 09 jari 50 branch. The user may change this to only use negative controls in the
1168 29 Sep 09 jari 51 current bioassay set.
1038 14 Apr 09 jari 52
1113 08 Jun 09 jari 53 The detection P-value plug-in does not filter the assays, it provides
1113 08 Jun 09 jari 54 the detection P-values usable in a filter step after running this
1113 08 Jun 09 jari 55 plug-in.
1038 14 Apr 09 jari 56
1113 08 Jun 09 jari 57 === Parameters ===
1113 08 Jun 09 jari 58
1122 10 Jun 09 jari 59 The plug-in requires input of array type since detection P-value are
1122 10 Jun 09 jari 60 calculated differently depending on array type.
1113 08 Jun 09 jari 61
1168 29 Sep 09 jari 62 Users may select to use negative controls in the current bioassay set
1168 29 Sep 09 jari 63 only. The default behaviour is to use all negative controls in the
1168 29 Sep 09 jari 64 root bioassay set for the current bioassay set.
1168 29 Sep 09 jari 65
1168 29 Sep 09 jari 66 A cut off parameter is available to exclude outliers within
1113 08 Jun 09 jari 67 the negative controls. The `cutoff` defines the acceptable negative
1113 08 Jun 09 jari 68 control signal range
1113 08 Jun 09 jari 69 {{{
1113 08 Jun 09 jari 70 median-MAD*cutoff < I < median+MAD*cutoff
1113 08 Jun 09 jari 71 }}}
1113 08 Jun 09 jari 72 where `MAD` is the median absolute deviation.
1113 08 Jun 09 jari 73
1113 08 Jun 09 jari 74 === Implementation details ===
1113 08 Jun 09 jari 75
1113 08 Jun 09 jari 76 Each assay is treated separately, i.e., no samples are combined
1122 10 Jun 09 jari 77 together. All calculations are made on the raw bead-type level data,
1122 10 Jun 09 jari 78 i.e., on the average expression value for each bead type and raw data
1122 10 Jun 09 jari 79 is always used irrespective when in analysis the detection P-value is
1122 10 Jun 09 jari 80 calculated.
1113 08 Jun 09 jari 81
1167 28 Sep 09 jari 82 ''Pvalue calculation for whole genome arrays:''
1113 08 Jun 09 jari 83
1113 08 Jun 09 jari 84 For all signals `i` calculate the detection P-value as
1122 10 Jun 09 jari 85 `Pvalue = 1-R/N` where `R` is the rank of the signal `i` relative to the
1114 09 Jun 09 jari 86 negative controls and `N` is the number of negative controls.
1113 08 Jun 09 jari 87
1167 28 Sep 09 jari 88 ''Pvalue calculation for others array types (DASL, miRNA, !VeraCode
1167 28 Sep 09 jari 89 DASL, and Focused Arrays):''
1113 08 Jun 09 jari 90
1114 09 Jun 09 jari 91 For all signals `i` calculate the detection P-value as
1167 28 Sep 09 jari 92 `Pvalue = 1/2 - 1/2 * erf( [i-AvgControl]/StdControl/sqrt(2) )` where
1114 09 Jun 09 jari 93 `AvgControl` is the average intensity of the negative controls,
1122 10 Jun 09 jari 94 `StdControl` is the standard deviation of the the negative controls,
1122 10 Jun 09 jari 95 and `erf` is the error function
1114 09 Jun 09 jari 96 (http://mathworld.wolfram.com/Erf.html). The error function is used
1122 10 Jun 09 jari 97 for arguments within the range (-4,4). To save CPU cycles, the function
1114 09 Jun 09 jari 98 value for arguments outside this range is set to -1 and 1,
1114 09 Jun 09 jari 99 respectively.
1114 09 Jun 09 jari 100
1218 29 Mar 10 jari 101 A spot is considered to be a negative control spot if it has an
1218 29 Mar 10 jari 102 ''Control group name'' exactly matching the string ''negative''.
1114 09 Jun 09 jari 103
1203 11 Mar 10 jari 104
1218 29 Mar 10 jari 105
1179 20 Oct 09 jari 106 == Control Summary plots ==
1179 20 Oct 09 jari 107
1197 06 Mar 10 jari 108 This extension provides overview plots for Illumina expression data. The
1179 20 Oct 09 jari 109 'Overview plots' tab becomes available in the experiment analysis tree
1179 20 Oct 09 jari 110 when the user selects a bioassay set. The plots are automatically
1179 20 Oct 09 jari 111 generated when the user clicks on the Overview plots tab. The display
1179 20 Oct 09 jari 112 of the plots cannot be changed by the user and the same plot is shown
1179 20 Oct 09 jari 113 irrespective which bioassay set is selected.
1179 20 Oct 09 jari 114
1179 20 Oct 09 jari 115 Currently two control summary curves are generated in one plot; The
1179 20 Oct 09 jari 116 average intensity of perfect match beads in each assay, and the
1179 20 Oct 09 jari 117 average intensity of housekeeping beads in each assay.
1179 20 Oct 09 jari 118
1179 20 Oct 09 jari 119 The average intensity I_avg is calculated as
1179 20 Oct 09 jari 120
1179 20 Oct 09 jari 121     I_avg = sum[Iraw_i] / N
1179 20 Oct 09 jari 122
1179 20 Oct 09 jari 123 where N is the number of bead types in the sum, Iraw_i is the raw
1179 20 Oct 09 jari 124 mean intensity for bead type i.
1179 20 Oct 09 jari 125
1179 20 Oct 09 jari 126 A bead type is considered to belong to the perfect match group if it
1179 20 Oct 09 jari 127 is annotated with ':pm' in the reporter annotation column '[Rep]
1179 20 Oct 09 jari 128 Control group id', and a bead type is grouped as housekeeping if it is
1179 20 Oct 09 jari 129 annotated with 'housekeeping' in reporter annotator column '[Rep]
1179 20 Oct 09 jari 130 Control group id'.
1179 20 Oct 09 jari 131
1038 14 Apr 09 jari 132 ----------------------------------------------------------------------
1038 14 Apr 09 jari 133 {{{
1203 11 Mar 10 jari 134 Copyright (C) 2009, 2010 Jari Häkkinen
1038 14 Apr 09 jari 135
1038 14 Apr 09 jari 136 This file is part of Illumina plug-in package for BASE.
1038 14 Apr 09 jari 137 Available at http://baseplugins.thep.lu.se/
1038 14 Apr 09 jari 138 BASE main site: http://base.thep.lu.se/
1038 14 Apr 09 jari 139
1038 14 Apr 09 jari 140 This is free software; you can redistribute it and/or
1038 14 Apr 09 jari 141 modify it under the terms of the GNU General Public License
1038 14 Apr 09 jari 142 as published by the Free Software Foundation; either version 3
1038 14 Apr 09 jari 143 of the License, or (at your option) any later version.
1038 14 Apr 09 jari 144
1038 14 Apr 09 jari 145 The software is distributed in the hope that it will be useful,
1038 14 Apr 09 jari 146 but WITHOUT ANY WARRANTY; without even the implied warranty of
1038 14 Apr 09 jari 147 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1038 14 Apr 09 jari 148 GNU General Public License for more details.
1038 14 Apr 09 jari 149
1038 14 Apr 09 jari 150 You should have received a copy of the GNU General Public License
1038 14 Apr 09 jari 151 along with BASE. If not, see <http://www.gnu.org/licenses/>.
1038 14 Apr 09 jari 152 }}}
1038 14 Apr 09 jari 153 ----------------------------------------------------------------------

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