source: trunk/se/lu/thep/affymetrix/README @ 350

Last change on this file since 350 was 345, checked in by Jari Häkkinen, 15 years ago

Fixes #67 and #68. Added information on how to install in Microsoft Windows. Also improved the docs.

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