plugins/base2/net.sf.basedb.illumina/trunk/contrib/README_beadstudio2ibs.txt

Code
Comments
Other
Rev Date Author Line
937 20 Jan 09 jari 1 ----------------------------------------------------------------------
937 20 Jan 09 jari 2 {{{
937 20 Jan 09 jari 3 $Id$
937 20 Jan 09 jari 4
937 20 Jan 09 jari 5 Copyright (C) 2009 Markus Ringnér
937 20 Jan 09 jari 6
937 20 Jan 09 jari 7 This file is part of Illumina plug-in package for BASE.
937 20 Jan 09 jari 8 Available at http://baseplugins.thep.lu.se/
937 20 Jan 09 jari 9 BASE main site: http://base.thep.lu.se/
937 20 Jan 09 jari 10
937 20 Jan 09 jari 11 This is free software; you can redistribute it and/or
937 20 Jan 09 jari 12 modify it under the terms of the GNU General Public License
940 27 Jan 09 martin 13 as published by the Free Software Foundation; either version 3
937 20 Jan 09 jari 14 of the License, or (at your option) any later version.
937 20 Jan 09 jari 15
937 20 Jan 09 jari 16 The software is distributed in the hope that it will be useful,
937 20 Jan 09 jari 17 but WITHOUT ANY WARRANTY; without even the implied warranty of
937 20 Jan 09 jari 18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
937 20 Jan 09 jari 19 GNU General Public License for more details.
937 20 Jan 09 jari 20
937 20 Jan 09 jari 21 You should have received a copy of the GNU General Public License
940 27 Jan 09 martin 22 along with this package. If not, see <http://www.gnu.org/licenses/>.
937 20 Jan 09 jari 23 }}}
937 20 Jan 09 jari 24 ----------------------------------------------------------------------
937 20 Jan 09 jari 25
937 20 Jan 09 jari 26 = Importing Illumina data from !BeadStudio into BASE =
937 20 Jan 09 jari 27
937 20 Jan 09 jari 28 This file contains information about how to generate expression
937 20 Jan 09 jari 29 data for the Illumina plug-in package from !BeadStudio.
937 20 Jan 09 jari 30
937 20 Jan 09 jari 31
937 20 Jan 09 jari 32 == Background ==
937 20 Jan 09 jari 33
937 20 Jan 09 jari 34 For expression data, the Illumina plug-ins package for BASE requires
937 20 Jan 09 jari 35 Illumina Bead Summary (IBS) files. IBS files contain bead-type level
937 20 Jan 09 jari 36 data for scanned Sentrix arrays. IBS files are simple comma separated
937 20 Jan 09 jari 37 text files with file extension .csv. IBS files are not outputted by a
937 20 Jan 09 jari 38 !BeadArray Reader with default settings, but a local Illumina Field
937 20 Jan 09 jari 39 Application Scientist can configure the !BeadArray Reader to output
937 20 Jan 09 jari 40 IBS files.  This document describes how to generate IBS files from
937 20 Jan 09 jari 41 !BeadStudio without requiring any changes of the default settings for
937 20 Jan 09 jari 42 the !BeadArray Reader.
937 20 Jan 09 jari 43
937 20 Jan 09 jari 44
937 20 Jan 09 jari 45 == !BeadStudio ==
937 20 Jan 09 jari 46
937 20 Jan 09 jari 47 ''Create !BeadStudio project'' 
937 20 Jan 09 jari 48
937 20 Jan 09 jari 49 Generate a !BeadStudio gene expression project with the experiments
937 20 Jan 09 jari 50 you want to generate IBS files for. The IBS files should contain data
937 20 Jan 09 jari 51 that is neither normalized nor background subtracted so:
937 20 Jan 09 jari 52
937 20 Jan 09 jari 53   * ''Analysis Type'' should be set to ''Gene Expression''.
937 20 Jan 09 jari 54
937 20 Jan 09 jari 55   * Set the parameter ''Normalization'' to ''none''.
937 20 Jan 09 jari 56
937 20 Jan 09 jari 57   * The parameter button ''Subtract Background'' should be unchecked.
937 20 Jan 09 jari 58
937 20 Jan 09 jari 59 ''Create and export !BeadStudio tables''
937 20 Jan 09 jari 60
937 20 Jan 09 jari 61 Two tables should be exported: ''Sample Probe Profile'' and ''Control
937 20 Jan 09 jari 62 Probe Profile''.
937 20 Jan 09 jari 63
937 20 Jan 09 jari 64 Note that the tables must be exactly as specified here: no additional
937 20 Jan 09 jari 65 columns are allowed and the order of the columns needs to be as
937 20 Jan 09 jari 66 specified.
937 20 Jan 09 jari 67
937 20 Jan 09 jari 68 ''Sample Probe Profile''
937 20 Jan 09 jari 69   
937 20 Jan 09 jari 70  1. Click on the ''Sample Probe Profile'' tab to view the table.
937 20 Jan 09 jari 71
937 20 Jan 09 jari 72  2. Click on the ''Column Chooser'' button to open the column chooser window.
937 20 Jan 09 jari 73
937 20 Jan 09 jari 74  3. Select displayed columns. The first column should be
937 20 Jan 09 jari 75  ''PROBE_ID'', followed by one column per sample, for example,
937 20 Jan 09 jari 76   4313143087_A, 4313143087_B, ...., and the last column should be
937 20 Jan 09 jari 77   ''ProbeID''. 
937 20 Jan 09 jari 78
937 20 Jan 09 jari 79  4. Select displayed subcolumns. The displayed subcolumns should be
937 20 Jan 09 jari 80  ''AVG_Signal'', ''BEAD_STDERR'', and ''Avg_NBEADS'', and in
937 20 Jan 09 jari 81  this order.
937 20 Jan 09 jari 82
937 20 Jan 09 jari 83  5. Export the table by clicking on the ''Export displayed data to a
937 20 Jan 09 jari 84  file '' button. Save as type ''Tab delimited (*.txt)''. In the
937 20 Jan 09 jari 85  following it is assumed that you have named the file
937 20 Jan 09 jari 86  ''sample_probe_profile.txt''.
937 20 Jan 09 jari 87
937 20 Jan 09 jari 88 ''Control Probe Profile''
937 20 Jan 09 jari 89   
937 20 Jan 09 jari 90  1. Click on the ''Control Probe Profile'' tab to view the table. If
937 20 Jan 09 jari 91  there is no ''Control Probe Profile'' tab, then first enable it
937 20 Jan 09 jari 92  under the pull-down menu ''Window''.
937 20 Jan 09 jari 93
937 20 Jan 09 jari 94  2. Click on the ''Column Chooser'' button to open the column chooser window.
937 20 Jan 09 jari 95
937 20 Jan 09 jari 96  3. Select displayed columns. The first displayed column should be
937 20 Jan 09 jari 97  ''ProbeID'', followed by one column per sample, for example,
937 20 Jan 09 jari 98  4313143087_A, 4313143087_B, .... The selection of samples should be
937 20 Jan 09 jari 99  the same and in the same order as in the exported ''Sample Probe
937 20 Jan 09 jari 100  Profile''.
937 20 Jan 09 jari 101
937 20 Jan 09 jari 102  4. Select displayed subcolumns. The shown subcolumns should be
937 20 Jan 09 jari 103  ''AVG_Signal'', ''BEAD_STDERR'', and ''Avg_NBEADS'', and in this
937 20 Jan 09 jari 104  order.
937 20 Jan 09 jari 105
937 20 Jan 09 jari 106  5. Export the table by clicking on the ''Export displayed data to a
937 20 Jan 09 jari 107  file '' button. Save as type ''Tab delimited (*.txt)''. In the
937 20 Jan 09 jari 108  following it is assumed that you have named the file
937 20 Jan 09 jari 109  ''control_probe_profile.txt''.
937 20 Jan 09 jari 110
937 20 Jan 09 jari 111
937 20 Jan 09 jari 112 == Convert !BeadStudio tables to IBS files ==
937 20 Jan 09 jari 113
937 20 Jan 09 jari 114 The two files exported from !BeadStudio with data for the sample probes
937 20 Jan 09 jari 115 and the control probes can be converted into an IBS file for each
937 20 Jan 09 jari 116 sample using ''beadstudio2ibs.pl'' with the following command:
937 20 Jan 09 jari 117 {{{  
937 20 Jan 09 jari 118 perl beadstudio2ibs.pl --samples_file=sample_probe_profile.txt --controls_file=control_probe_profile.txt
937 20 Jan 09 jari 119 }}}
937 20 Jan 09 jari 120
937 20 Jan 09 jari 121 == Import IBS files generated from !BeadStudio into BASE ==
937 20 Jan 09 jari 122
937 20 Jan 09 jari 123 The IBS files generated by ''beadstudio2ibs.pl'' can be imported into
937 20 Jan 09 jari 124 BASE using the following settings:
937 20 Jan 09 jari 125
937 20 Jan 09 jari 126  * Use the raw data type for the Illumina plug-in package:
937 20 Jan 09 jari 127    ''Illumina Bead Summary (IBS)''
937 20 Jan 09 jari 128
937 20 Jan 09 jari 129  * Use the option ''expression 1''.
937 20 Jan 09 jari 130
937 20 Jan 09 jari 131
937 20 Jan 09 jari 132 == Additional remarks ==
937 20 Jan 09 jari 133
937 20 Jan 09 jari 134  * The choice between ''expression 1'' and ''expression 2'' (and
937 20 Jan 09 jari 135    possibly more alternatives in the future) should be made to match
937 20 Jan 09 jari 136    the number of IBS files per sample. When IBS files are outputted
937 20 Jan 09 jari 137    directly from the !BeadArray Reader one .csv file is produced per
937 20 Jan 09 jari 138    strip on the array. !BeadStudio does not keep track of strips and
937 20 Jan 09 jari 139    therefore a single .csv file per sample is generated by
937 20 Jan 09 jari 140    ''beadstudio2ibs.pl'', regardless of the number of strips on the
937 20 Jan 09 jari 141    beadchips used. This means, for example, that for HumanWG-6 v3.0
937 20 Jan 09 jari 142    beadchips (two strips per sample) ''expression 2'' should be used
937 20 Jan 09 jari 143    when IBS files are generated from the scanner and ''expression 1''
937 20 Jan 09 jari 144    should be used when IBS file are generated from !BeadStudio data.
937 20 Jan 09 jari 145
937 20 Jan 09 jari 146  * The data in an IBS file from !BeadStudio will not be identical to
937 20 Jan 09 jari 147    the data in an IBS file from the scanner. The reason for this
937 20 Jan 09 jari 148    difference is that the scanner outputs the average intensity for all
937 20 Jan 09 jari 149    beads, whereas !BeadStudio removes outlier beads in its calculation
937 20 Jan 09 jari 150    of averages.

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