plugins/base2/se.lu.thep.affymetrix/trunk/README

Code
Comments
Other
Rev Date Author Line
123 12 Jul 06 jari 1 $Id$
123 12 Jul 06 jari 2
275 21 May 07 peter 3 ---------------------------------------------------------------------
275 21 May 07 peter 4 {{{
123 12 Jul 06 jari 5 Copyright (C) 2006 Jari Häkkinen
285 22 May 07 jari 6 Copyright (C) 2007 Jari Häkkinen, Peter Johansson
123 12 Jul 06 jari 7
275 21 May 07 peter 8 This file is part of se.lu.thep.affymetrix package for BASE,
275 21 May 07 peter 9 http://baseplugins.thep.lu.se/wiki/se.thep.lu.se.affymetrix
123 12 Jul 06 jari 10
275 21 May 07 peter 11 se.lu.thep.affymetrix package for BASE is free software; you can
275 21 May 07 peter 12 redistribute it and/or modify it under the terms of the GNU General
275 21 May 07 peter 13 Public License as published by the Free Software Foundation; either
275 21 May 07 peter 14 version 2 of the License, or (at your option) any later version.
123 12 Jul 06 jari 15
275 21 May 07 peter 16 se.lu.thep.affymetrix package for BASE is distributed in the hope that
275 21 May 07 peter 17 it will be useful, but WITHOUT ANY WARRANTY; without even the implied
275 21 May 07 peter 18 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
275 21 May 07 peter 19 the GNU General Public License for more details.
123 12 Jul 06 jari 20
123 12 Jul 06 jari 21 You should have received a copy of the GNU General Public License
123 12 Jul 06 jari 22 along with this program; if not, write to the Free Software
123 12 Jul 06 jari 23 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
123 12 Jul 06 jari 24 USA.
275 21 May 07 peter 25 }}}
275 21 May 07 peter 26 ----------------------------------------------------------------------
123 12 Jul 06 jari 27
285 22 May 07 jari 28 == About se.lu.thep.affymetrix package ==
123 12 Jul 06 jari 29
286 22 May 07 jari 30 ''A short diversion before we proceed, this paragraph is aimed at
286 22 May 07 jari 31 people starting with an empty BASE server. The default BASE
286 22 May 07 jari 32 installation comes set up to store the same reporter (probeset)
286 22 May 07 jari 33 information as BASE 1.2.x do. This set up is not optimal for
286 22 May 07 jari 34 Affymetrix data but can still be used. In order to understand how to
286 22 May 07 jari 35 define what reporter information is stored in BASE and how to change
286 22 May 07 jari 36 what is stored, you may want to visit
345 27 Jun 07 jari 37 http://base.thep.lu.se/chrome/site/doc/html/appendix/appendix.extendedproperties.html
286 22 May 07 jari 38 before you start using your shiny BASE installation.''
286 22 May 07 jari 39
279 22 May 07 jari 40 Send comments, suggestion, complaints, or questions regarding this
285 22 May 07 jari 41 package to the
285 22 May 07 jari 42 [http://base.thep.lu.se/wiki/MailingLists BASE mailing lists].
123 12 Jul 06 jari 43
275 21 May 07 peter 44 This file contains information on se.lu.thep.affymetrix package. This
278 22 May 07 peter 45 package contains the RMAExpress and Plier plug-ins.
123 12 Jul 06 jari 46
345 27 Jun 07 jari 47 The plug-ins in this package are installed in the
345 27 Jun 07 jari 48 [http://base2.thep.lu.se:8080/demo BASE2 demo server]. You can try
345 27 Jun 07 jari 49 them there before deciding to install them in your local BASE server.
123 12 Jul 06 jari 50
275 21 May 07 peter 51 For installation or updating instructions please see file INSTALL.
156 10 Aug 06 jari 52
156 10 Aug 06 jari 53
285 22 May 07 jari 54 == What is RMAExpress and Plier plug-ins for BASE? ==
123 12 Jul 06 jari 55
276 21 May 07 peter 56 RMAExpress and Plier are two similar plug-ins needed to make use of
416 07 Sep 07 jari 57 Affymetrix expression chip data in BASE. Affymetrix data can be
416 07 Sep 07 jari 58 imported into BASE as files, but if one wants to perform clustering
416 07 Sep 07 jari 59 and other analysis available in BASE, the data in these files have to
416 07 Sep 07 jari 60 be extracted and imported into BASE. NOTE, these plug-ins cannot
416 07 Sep 07 jari 61 handle snp chip data.
123 12 Jul 06 jari 62
285 22 May 07 jari 63 These plug-ins do not implement the RMA method and Plier method, but
285 22 May 07 jari 64 rather rely on third-party binary packages for the algorithm
285 22 May 07 jari 65 implementations.
123 12 Jul 06 jari 66
276 21 May 07 peter 67 The RMAExpress plug-in relies on RMAExpressConsole available in the
276 21 May 07 peter 68 RMAExpress package available at http://rmaexpress.bmbolstad.com/. The
276 21 May 07 peter 69 RMA algorithm is published in scientific journals, for more
276 21 May 07 peter 70 information please refer to the RMAExpress web site. In short RMA is
276 21 May 07 peter 71 the Robust Multichip Average. It consists of three steps: a background
285 22 May 07 jari 72 adjustment, quantile normalization, and finally a summarizing.
124 18 Jul 06 jari 73
276 21 May 07 peter 74 The Plier plug-in relies on `apt-probeset-summarize` included in
276 21 May 07 peter 75 Affymetrix Power Tools (APT) available at
276 21 May 07 peter 76 http://www.affymetrix.com/support/developer/powertools/index.affx.
293 23 May 07 peter 77 `apt-probeset-summarize` provides several methods and options. For
293 23 May 07 peter 78 time being there is no way to to set these options through the BASE
293 23 May 07 peter 79 GUI. The option `plier-mm` is hard-coded into the plug-in, which
294 23 May 07 peter 80 should be a good choice in most situations. In short the option means
293 23 May 07 peter 81 mismatch probe is used as adjustment for perfect match, quantile
293 23 May 07 peter 82 normalization is done, and PLIER is used for summarizing probesets.
293 23 May 07 peter 83 For more information regarding the PLIER algorithm please refer to the
293 23 May 07 peter 84 Affymetrix home page.
276 21 May 07 peter 85
123 12 Jul 06 jari 86
285 22 May 07 jari 87 == What is required for use of these plug-ins for BASE? ==
123 12 Jul 06 jari 88
285 22 May 07 jari 89 This section is a short introduction to get going with the plug-ins
285 22 May 07 jari 90 and Affymetrix data in BASE. More documentation is available at
345 27 Jun 07 jari 91 http://base.thep.lu.se/ and you should read them to learn how to use
345 27 Jun 07 jari 92 BASE.
123 12 Jul 06 jari 93
285 22 May 07 jari 94  1. You need to install the plug-in and make BASE aware of the new
285 22 May 07 jari 95     plug-in, see INSTALL for instruction for installation instructions.
285 22 May 07 jari 96
285 22 May 07 jari 97  2. You need to import probe set information into BASE (reporter
285 22 May 07 jari 98     information in BASE language), i.e. import AffyChip_annot.csv into
285 22 May 07 jari 99     BASE. This is only needed to do once, and optionally later if
285 22 May 07 jari 100     reporter information should be updated. This step can only be
285 22 May 07 jari 101     performed by a user with reporter administrative (create)
285 22 May 07 jari 102     privileges, an ordinary BASE user does NOT have this privilege.
285 22 May 07 jari 103
345 27 Jun 07 jari 104     There is more than one way to create plug-in configurations. Here
345 27 Jun 07 jari 105     we outline the most straightforward route. There is a chapter in
345 27 Jun 07 jari 106     the BASE manual devoted for plug-in installation, follow the link
345 27 Jun 07 jari 107     above to find the document.
285 22 May 07 jari 108
126 20 Jul 06 jari 109     - First you need to create an plug-in configuration for the
126 20 Jul 06 jari 110       'Reporter importer' plug-in. Locate the 'Reporter importer'
126 20 Jul 06 jari 111       plug-in definition ('Administrate' -> 'Plugins' ->
126 20 Jul 06 jari 112       'Definitions'). Click on it and choose 'New configuration ...',
126 20 Jul 06 jari 113       name the configuration and choose 'Save and configure'.
125 20 Jul 06 jari 114
126 20 Jul 06 jari 115     - A 'Parser settings' dialog will appear. Set fields according to
126 20 Jul 06 jari 116       this list:
285 22 May 07 jari 117 {{{
126 20 Jul 06 jari 118   Data header  : "Probe Set ID","GeneChip Array",.*
126 20 Jul 06 jari 119   Data splitter: (?!"),(?=")
126 20 Jul 06 jari 120   Remove quotes: true
126 20 Jul 06 jari 121   Name         : \Probe Set ID\
126 20 Jul 06 jari 122   Reporter ID  : \Probe Set ID\
285 22 May 07 jari 123 }}}
285 22 May 07 jari 124       Finalize by clicking 'Next'. Note, the above example will
285 22 May 07 jari 125       perform a minimalistic import of annotation information, please
285 22 May 07 jari 126       read the BASE documentation on how to import more probeset
285 22 May 07 jari 127       related information. However, don't worry about that now, you
285 22 May 07 jari 128       can always fix the annotation later.
125 20 Jul 06 jari 129
126 20 Jul 06 jari 130     - Import the reporters by choosing 'View' -> 'Reporters' and the
126 20 Jul 06 jari 131       clicking on 'Import...'. Click 'Next' without changing the 'auto
156 10 Aug 06 jari 132       detect' settings. Supply the file name in the next dialog, click
126 20 Jul 06 jari 133       'Next'. Set the 'Update existing reporters' to "true" if an
126 20 Jul 06 jari 134       update of already stored reporter information is wanted. Start
286 22 May 07 jari 135       the import by clicking 'Next' in the parameter dialog.
125 20 Jul 06 jari 136
345 27 Jun 07 jari 137     The reporter information is now in the database. You may delete
345 27 Jun 07 jari 138     the AffyChip_annot.csv file from BASE if you wish, it is not
345 27 Jun 07 jari 139     needed anymore. You may want to update reporter information when
345 27 Jun 07 jari 140     Affymetrix releases a new version of their annotation but remember
345 27 Jun 07 jari 141     there is no versioning for this type of information in BASE. If
345 27 Jun 07 jari 142     you update reporter information you only need to redo the last
345 27 Jun 07 jari 143     step.
126 20 Jul 06 jari 144
286 22 May 07 jari 145  3. You need to define the design of the !AffyChip in BASE,
286 22 May 07 jari 146     i.e. import the !AffyChip.cdf file. This is only needed to do once
286 22 May 07 jari 147     for every !AffyChip design to be added into BASE. This step can
286 22 May 07 jari 148     only be performed by a user with array LIMS administrative
286 22 May 07 jari 149     (create) privileges, an ordinary BASE user does NOT have this
286 22 May 07 jari 150     privilege.
123 12 Jul 06 jari 151
126 20 Jul 06 jari 152     - Define a new array design through 'Array LIMS' -> 'Array
126 20 Jul 06 jari 153       Designs'. Click on 'New ...'. In the 'Create array design'
285 22 May 07 jari 154       dialog, set the 'Name' (use the file name of the CDF file for
188 26 Oct 06 jari 155       convenience), tick the Affy chip tick box, choose a CDF file,
188 26 Oct 06 jari 156       and optionally write a description. Click on next, and the new
188 26 Oct 06 jari 157       design is created.
126 20 Jul 06 jari 158
126 20 Jul 06 jari 159     - Remember to share the design to all users/roles/groups that
126 20 Jul 06 jari 160       should have access to it (sharing it to group Everyone should be
127 22 Jul 06 jari 161       sufficient in most cases).
126 20 Jul 06 jari 162
285 22 May 07 jari 163  4. Create an experiment, i.e., grouping .cel files into an
285 22 May 07 jari 164     experiment.
123 12 Jul 06 jari 165
127 22 Jul 06 jari 166     - Upload the .cel files into BASE.
124 18 Jul 06 jari 167
127 22 Jul 06 jari 168     - Create raw bio assay for these files, one per file: Choose
127 22 Jul 06 jari 169       'View' -> 'Raw bioassays', click on 'New ...'. In the dialog set
127 22 Jul 06 jari 170       the 'Name', choose the proper 'Raw data type' (i.e.,
127 22 Jul 06 jari 171       "Affymetrix"), choose the 'Array design' that matches the .cel
127 22 Jul 06 jari 172       file, and choose the 'CEL file'. (The other fields are not
127 22 Jul 06 jari 173       needed but may be handy to fill in.) Click on 'Save'.
127 22 Jul 06 jari 174
127 22 Jul 06 jari 175     - Create the experiment: Choose 'View' -> 'Experiment', click on
127 22 Jul 06 jari 176       'New ...'. In the dialog set the 'Name', choose the proper 'Raw
127 22 Jul 06 jari 177       data type' (i.e., "Affymetrix"), and add 'Raw bioassays'.
127 22 Jul 06 jari 178
285 22 May 07 jari 179  5. Select the experiment and create a new root bioassay set for it.
127 22 Jul 06 jari 180
127 22 Jul 06 jari 181     - Locate the newly created experiment and click on 'Analyze'.
127 22 Jul 06 jari 182
285 22 May 07 jari 183     - Click on 'New root bioassay set ...', select the algorithm you
285 22 May 07 jari 184       want to use in the import, and click 'Next' in the pop-up
285 22 May 07 jari 185       dialog. Select the 'Raw bioassays' to include in the new root
285 22 May 07 jari 186       bioassay set and type a name for the bioassay set. Click on
127 22 Jul 06 jari 187       'Next' to start the plug-in.
127 22 Jul 06 jari 188
285 22 May 07 jari 189  6. When the plug-in is finished the resulting expression values will
285 22 May 07 jari 190     be accessible in BASE.
574 07 Feb 08 jari 191     [[br]][[br]]
574 07 Feb 08 jari 192     In some cases the reporter annotation file from Affymetrix fails
574 07 Feb 08 jari 193     to describe all probe sets on the chip, you may get a message like
574 07 Feb 08 jari 194     ''Error: Unable to import root bioassay. Item not found:
574 07 Feb 08 jari 195     Reporter[externalId=AFFX-2315060]''. In this case you have to fall
574 07 Feb 08 jari 196     back to importing the probe set information using the CDF
574 07 Feb 08 jari 197     file, simply do 
574 07 Feb 08 jari 198     [[br]][[br]]
574 07 Feb 08 jari 199     Import the reporters by choosing 'View' -> 'Reporters' and the
574 07 Feb 08 jari 200     clicking on 'Import...'. Click 'Next' without changing the 'auto
574 07 Feb 08 jari 201     detect' settings. Supply the CDF file name in the next dialog,
574 07 Feb 08 jari 202     click 'Next'. Start the import by clicking 'Next' in the parameter
574 07 Feb 08 jari 203     dialog. This will add the missing probe sets without changing
574 07 Feb 08 jari 204     existing probe sets. The new probe sets will not have any
574 07 Feb 08 jari 205     annotations associated with them since the CDFs do not contain
574 07 Feb 08 jari 206     such information.
285 22 May 07 jari 207
285 22 May 07 jari 208  7. You made it here. This means that the plug-in works and you are
345 27 Jun 07 jari 209     ready to start using Affymetrix data in BASE. The get the most out
345 27 Jun 07 jari 210     of BASE you should now read the BASE manual and documentation
345 27 Jun 07 jari 211     available at http://base.thep.lu.se/

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