doc/src/docbook/appendix/coreplugins.xml

Code
Comments
Other
Rev Date Author Line
3334 14 May 07 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
3334 14 May 07 nicklas 2 <!DOCTYPE appendix PUBLIC 
3334 14 May 07 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3334 14 May 07 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3334 14 May 07 nicklas 5 <!--
3334 14 May 07 nicklas 6   $Id$
3334 14 May 07 nicklas 7   
4043 06 Dec 07 jari 8   Copyright (C) 2007 Jari Häkkinen, Nicklas Nordborg
4429 01 Sep 08 jari 9   Copyright (C) 2008 Jari Häkkinen
3334 14 May 07 nicklas 10   
3334 14 May 07 nicklas 11   This file is part of BASE - BioArray Software Environment.
3334 14 May 07 nicklas 12   Available at http://base.thep.lu.se/
3334 14 May 07 nicklas 13   
3334 14 May 07 nicklas 14   BASE is free software; you can redistribute it and/or
3334 14 May 07 nicklas 15   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 16   as published by the Free Software Foundation; either version 3
3334 14 May 07 nicklas 17   of the License, or (at your option) any later version.
3334 14 May 07 nicklas 18   
3334 14 May 07 nicklas 19   BASE is distributed in the hope that it will be useful,
3334 14 May 07 nicklas 20   but WITHOUT ANY WARRANTY; without even the implied warranty of
3334 14 May 07 nicklas 21   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3334 14 May 07 nicklas 22   GNU General Public License for more details.
3334 14 May 07 nicklas 23   
3334 14 May 07 nicklas 24   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 25   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3334 14 May 07 nicklas 26 -->
3334 14 May 07 nicklas 27
3334 14 May 07 nicklas 28 <appendix id="appendix.coreplugins">
5782 04 Oct 11 nicklas 29   <?dbhtml filename="coreplugins.html" ?>
3334 14 May 07 nicklas 30   <title>Core plug-ins shipped with BASE</title>
4043 06 Dec 07 jari 31
3334 14 May 07 nicklas 32   <para>
5820 24 Oct 11 nicklas 33     Here is a categorized list of all plug-ins installed with a pristine BASE
5820 24 Oct 11 nicklas 34     installation. Some plug-ins must be configured before use. The
4043 06 Dec 07 jari 35     requirements are listed below and configuration samples are given
4487 08 Sep 08 jari 36     for for plug-ins that supports/requires configurations. Use the
4043 06 Dec 07 jari 37     right-click menu of the mouse to download these XML files for
4043 06 Dec 07 jari 38     further import into BASE (see <xref
4043 06 Dec 07 jari 39     linkend="plugins.configuration.importexport" />).
4043 06 Dec 07 jari 40   </para>
4043 06 Dec 07 jari 41
4043 06 Dec 07 jari 42   <para>
4043 06 Dec 07 jari 43     Contributed plug-ins are available at <ulink
7982 14 Jun 21 nicklas 44     url="https://baseplugins.thep.lu.se" >https://baseplugins.thep.lu.se
4487 08 Sep 08 jari 45     </ulink>. These plug-ins are either developed outside the core team
4043 06 Dec 07 jari 46     or require external non-Java compilers and tools. These packages
4043 06 Dec 07 jari 47     are excluded from the BASE package to make the installation
4043 06 Dec 07 jari 48     process somewhat simpler.
4043 06 Dec 07 jari 49   </para>
4043 06 Dec 07 jari 50       
4043 06 Dec 07 jari 51   <sect1 id="coreplugins.analyze">
4432 01 Sep 08 jari 52     <title>Core analysis plug-ins</title>
4043 06 Dec 07 jari 53
4043 06 Dec 07 jari 54     <variablelist>
4043 06 Dec 07 jari 55       <varlistentry>
5820 24 Oct 11 nicklas 56         <term>BASE 1 plug-in executor</term>
4043 06 Dec 07 jari 57         <listitem>
4043 06 Dec 07 jari 58           <para>
5820 24 Oct 11 nicklas 59             Simulates the plug-in runner from Base 1.2. Must be configured
5820 24 Oct 11 nicklas 60             before use. The recommended approach is to use the plug-in configuration
5820 24 Oct 11 nicklas 61             file from the BASE 1.2 installation. See <xref linkend="plugins.installation.base1"
5820 24 Oct 11 nicklas 62             /> for more information.
4043 06 Dec 07 jari 63           </para>
5820 24 Oct 11 nicklas 64         </listitem>
5820 24 Oct 11 nicklas 65       </varlistentry>
5820 24 Oct 11 nicklas 66
5820 24 Oct 11 nicklas 67       <varlistentry>
5820 24 Oct 11 nicklas 68         <term>External program executor</term>
5820 24 Oct 11 nicklas 69         <listitem>
4043 06 Dec 07 jari 70           <para>
5820 24 Oct 11 nicklas 71             Export data from BASE and execute an external program for analysis. 
5820 24 Oct 11 nicklas 72             Afterwards, data can be imported back to BASE. A configuration is needed
5820 24 Oct 11 nicklas 73             to run this plug-in. The plug-in is very flexible and can handle several 
5820 24 Oct 11 nicklas 74             export/import data formats (which can be extended by
5820 24 Oct 11 nicklas 75             adding special export/import plug-ins). Here is a list of the built-in
5820 24 Oct 11 nicklas 76             exporter/importer implementations.
4043 06 Dec 07 jari 77           </para>
5820 24 Oct 11 nicklas 78           
5820 24 Oct 11 nicklas 79           <itemizedlist>
5820 24 Oct 11 nicklas 80             <listitem>
5820 24 Oct 11 nicklas 81               <para>
5820 24 Oct 11 nicklas 82               <emphasis>BASEFile exporter for the ExternalProgramExecutor</emphasis>: Exporter implementation
5820 24 Oct 11 nicklas 83               that export data in BASE file format.
5820 24 Oct 11 nicklas 84               </para>
5820 24 Oct 11 nicklas 85             </listitem>
5820 24 Oct 11 nicklas 86             <listitem>
5820 24 Oct 11 nicklas 87               <para>
5820 24 Oct 11 nicklas 88               <emphasis>BASEfile importer for the ExternalProgramExecutor</emphasis>: Importer implementation
5820 24 Oct 11 nicklas 89               that can import data in BASEfile format.
5820 24 Oct 11 nicklas 90               </para>
5820 24 Oct 11 nicklas 91             </listitem>
5820 24 Oct 11 nicklas 92             <listitem>
5820 24 Oct 11 nicklas 93               <para>
5820 24 Oct 11 nicklas 94               <emphasis>BFS exporter for the ExternalProgramExecutor</emphasis>: Exporter implementation
5820 24 Oct 11 nicklas 95               that export data in BFS file format.
5820 24 Oct 11 nicklas 96               </para>
5820 24 Oct 11 nicklas 97             </listitem>
5820 24 Oct 11 nicklas 98             <listitem>
5820 24 Oct 11 nicklas 99               <para>
5820 24 Oct 11 nicklas 100               <emphasis>BFS importer for the ExternalProgramExecutor</emphasis>: Importer implementation
5820 24 Oct 11 nicklas 101               that can import data in BFS file format.
5820 24 Oct 11 nicklas 102               </para>
5820 24 Oct 11 nicklas 103             </listitem>
5820 24 Oct 11 nicklas 104             <listitem>
5820 24 Oct 11 nicklas 105               <para>
5820 24 Oct 11 nicklas 106               <emphasis>File-only importer for the ExternalProgramExecutor</emphasis>: Importer implementation
5820 24 Oct 11 nicklas 107               that simply upload all created files to BASE.
5820 24 Oct 11 nicklas 108               </para>
5820 24 Oct 11 nicklas 109             </listitem>
5820 24 Oct 11 nicklas 110           </itemizedlist>
5820 24 Oct 11 nicklas 111           
5820 24 Oct 11 nicklas 112           <note>
5820 24 Oct 11 nicklas 113             <para>
5820 24 Oct 11 nicklas 114             This plug-in can in theory handle everything (and more) that the 
5820 24 Oct 11 nicklas 115             <emphasis>BASE 1 plug-in executor</emphasis> can, except that it doesn't do
5820 24 Oct 11 nicklas 116             any translation of field names used in BASE 1.
5820 24 Oct 11 nicklas 117             </para>  
5820 24 Oct 11 nicklas 118           </note>
5820 24 Oct 11 nicklas 119           
4043 06 Dec 07 jari 120         </listitem>
4043 06 Dec 07 jari 121       </varlistentry>
4043 06 Dec 07 jari 122
4043 06 Dec 07 jari 123       <varlistentry>
5820 24 Oct 11 nicklas 124         <term>Formula extra value calculator</term>
4043 06 Dec 07 jari 125         <listitem>
4043 06 Dec 07 jari 126           <para>
5820 24 Oct 11 nicklas 127             Calculates extra values for a bioassay set using a user-defined
5820 24 Oct 11 nicklas 128             formula. No configuration is needed.
4043 06 Dec 07 jari 129           </para>
4043 06 Dec 07 jari 130         </listitem>
4043 06 Dec 07 jari 131       </varlistentry>
4043 06 Dec 07 jari 132
4043 06 Dec 07 jari 133       <varlistentry>
5820 24 Oct 11 nicklas 134         <term>Formula filter</term>
4043 06 Dec 07 jari 135         <listitem>
4043 06 Dec 07 jari 136           <para>
5820 24 Oct 11 nicklas 137             Filters a bioassay set using a user-defined formula. 
5820 24 Oct 11 nicklas 138             No configuration is needed.
4043 06 Dec 07 jari 139           </para>
4043 06 Dec 07 jari 140         </listitem>
4043 06 Dec 07 jari 141       </varlistentry>
4043 06 Dec 07 jari 142
4043 06 Dec 07 jari 143       <varlistentry>
5820 24 Oct 11 nicklas 144         <term>Formula intensity transformer</term>
4043 06 Dec 07 jari 145         <listitem>
4043 06 Dec 07 jari 146           <para>
5820 24 Oct 11 nicklas 147             Creates a new bioassay set with transformed intensity values using a
5820 24 Oct 11 nicklas 148             user-defined formula. No configuration is needed.
4043 06 Dec 07 jari 149           </para>
4043 06 Dec 07 jari 150         </listitem>
4043 06 Dec 07 jari 151       </varlistentry>
5820 24 Oct 11 nicklas 152
5035 29 Jul 09 martin 153       <varlistentry>
5820 24 Oct 11 nicklas 154         <term>Manual derived bioassay creator</term>
5035 29 Jul 09 martin 155         <term>Manual transformation</term>
5035 29 Jul 09 martin 156         <listitem>
5035 29 Jul 09 martin 157           <para>
5035 29 Jul 09 martin 158             Allows a user to manually register an external analysis procedure that has 
5035 29 Jul 09 martin 159             happened outside of BASE and to register the parameters used and the generated 
5820 24 Oct 11 nicklas 160             output files. On plug-in create a derived bioassay set and the other
5820 24 Oct 11 nicklas 161             a transformation/bioassay set. Both plug-ins need a configuration to
5820 24 Oct 11 nicklas 162             register possible parameters and output files.
5035 29 Jul 09 martin 163           </para>
5035 29 Jul 09 martin 164         </listitem>
5035 29 Jul 09 martin 165       </varlistentry>
4043 06 Dec 07 jari 166
4043 06 Dec 07 jari 167       <varlistentry>
4043 06 Dec 07 jari 168         <term>Normalisation: Lowess</term>
4043 06 Dec 07 jari 169         <listitem>
4043 06 Dec 07 jari 170           <para>
5820 24 Oct 11 nicklas 171             Normalisation using LOWESS algorithm. No configuration is
5820 24 Oct 11 nicklas 172             needed.
4043 06 Dec 07 jari 173           </para>
4043 06 Dec 07 jari 174         </listitem>
4043 06 Dec 07 jari 175       </varlistentry>
4043 06 Dec 07 jari 176
4043 06 Dec 07 jari 177       <varlistentry>
4043 06 Dec 07 jari 178         <term>Normalisation: Median ratio</term>
4043 06 Dec 07 jari 179         <listitem>
4043 06 Dec 07 jari 180           <para>
5820 24 Oct 11 nicklas 181             Normalisation based on median ratio. No configuration is needed.
4043 06 Dec 07 jari 182           </para>
4043 06 Dec 07 jari 183         </listitem>
4043 06 Dec 07 jari 184       </varlistentry>
4043 06 Dec 07 jari 185     </variablelist>
4043 06 Dec 07 jari 186
4043 06 Dec 07 jari 187   </sect1>
4043 06 Dec 07 jari 188
4043 06 Dec 07 jari 189   <sect1 id="coreplugins.export">
4432 01 Sep 08 jari 190     <title>Core export plug-ins</title>
4043 06 Dec 07 jari 191
5820 24 Oct 11 nicklas 192     <para>
5820 24 Oct 11 nicklas 193       Unless otherwise noted, none of the export plug-ins 
5820 24 Oct 11 nicklas 194       need a configuration.
5820 24 Oct 11 nicklas 195     </para>
5820 24 Oct 11 nicklas 196
4043 06 Dec 07 jari 197     <variablelist>
4043 06 Dec 07 jari 198       <varlistentry>
5035 29 Jul 09 martin 199         <term>BASEfile exporter</term>
4043 06 Dec 07 jari 200         <listitem>
4043 06 Dec 07 jari 201           <para>
5035 29 Jul 09 martin 202             Exports bioassay set data to serial or matrix BASEfile format.
4043 06 Dec 07 jari 203           </para>
5820 24 Oct 11 nicklas 204         </listitem>
5820 24 Oct 11 nicklas 205       </varlistentry>
5820 24 Oct 11 nicklas 206       
5820 24 Oct 11 nicklas 207       <varlistentry>
5820 24 Oct 11 nicklas 208         <term>BFS exporter</term>
5820 24 Oct 11 nicklas 209         <listitem>
4043 06 Dec 07 jari 210           <para>
5820 24 Oct 11 nicklas 211             Exports bioassay set data to BFS format.
4043 06 Dec 07 jari 212           </para>
4043 06 Dec 07 jari 213         </listitem>
4043 06 Dec 07 jari 214       </varlistentry>
5035 29 Jul 09 martin 215       
5035 29 Jul 09 martin 216       <varlistentry>
5035 29 Jul 09 martin 217         <term>GAL exporter</term>
5035 29 Jul 09 martin 218         <listitem>
5035 29 Jul 09 martin 219           <para>
5035 29 Jul 09 martin 220             Exports the features of an array design to a GAL file.
5035 29 Jul 09 martin 221           </para>
5035 29 Jul 09 martin 222         </listitem>
5035 29 Jul 09 martin 223       </varlistentry>
4043 06 Dec 07 jari 224
4043 06 Dec 07 jari 225       <varlistentry>
4043 06 Dec 07 jari 226         <term>Help texts exporter</term>
4043 06 Dec 07 jari 227         <listitem>
4043 06 Dec 07 jari 228           <para>
4043 06 Dec 07 jari 229             Exports help texts to an XML file.
4043 06 Dec 07 jari 230           </para>
4043 06 Dec 07 jari 231         </listitem>
4043 06 Dec 07 jari 232       </varlistentry>
4043 06 Dec 07 jari 233
4043 06 Dec 07 jari 234       <varlistentry>
4043 06 Dec 07 jari 235         <term>Packed file exporter</term>
4043 06 Dec 07 jari 236         <listitem>
4043 06 Dec 07 jari 237           <para>
5820 24 Oct 11 nicklas 238             Exports files and directories as an archive-file. A configuration
5820 24 Oct 11 nicklas 239             is needed to specify compression format. Support for the following
5820 24 Oct 11 nicklas 240             formats are included in BASE:
4043 06 Dec 07 jari 241           </para>
5820 24 Oct 11 nicklas 242           
5820 24 Oct 11 nicklas 243           <itemizedlist>
5820 24 Oct 11 nicklas 244             <listitem>
5820 24 Oct 11 nicklas 245               <para>
5820 24 Oct 11 nicklas 246               <emphasis>BZipped TAR archive</emphasis>: Collects the selected files/directories 
5820 24 Oct 11 nicklas 247               into a TAR file and compress it with BZIP2.
5820 24 Oct 11 nicklas 248               </para>
5820 24 Oct 11 nicklas 249             </listitem>
5820 24 Oct 11 nicklas 250             <listitem>
5820 24 Oct 11 nicklas 251               <para>
5820 24 Oct 11 nicklas 252               <emphasis>GZipped TAR archive</emphasis>: Collects the selected files/directories 
5820 24 Oct 11 nicklas 253               into a TAR file and compress it with GZIP.
5820 24 Oct 11 nicklas 254               </para>
5820 24 Oct 11 nicklas 255             </listitem>
5820 24 Oct 11 nicklas 256             <listitem>
5820 24 Oct 11 nicklas 257               <para>
5820 24 Oct 11 nicklas 258               <emphasis>TAR archive</emphasis>: Collects the selected files/directories 
5820 24 Oct 11 nicklas 259               into an uncompressed TAR file.
5820 24 Oct 11 nicklas 260               </para>
5820 24 Oct 11 nicklas 261             </listitem>
5820 24 Oct 11 nicklas 262             <listitem>
5820 24 Oct 11 nicklas 263               <para>
5820 24 Oct 11 nicklas 264               <emphasis>ZIP archive</emphasis>: Collects the selected files/directories 
5820 24 Oct 11 nicklas 265               into a ZIP file.
5820 24 Oct 11 nicklas 266               </para>
5820 24 Oct 11 nicklas 267             </listitem>
5820 24 Oct 11 nicklas 268           </itemizedlist>
5820 24 Oct 11 nicklas 269           
4043 06 Dec 07 jari 270           <para>
5820 24 Oct 11 nicklas 271             See <xref linkend="plugin_developer.other.packer"/> for information
5820 24 Oct 11 nicklas 272             about implementing support for other file formats.  
4043 06 Dec 07 jari 273           </para>
5820 24 Oct 11 nicklas 274           
4043 06 Dec 07 jari 275         </listitem>
4043 06 Dec 07 jari 276       </varlistentry>
4043 06 Dec 07 jari 277
4043 06 Dec 07 jari 278       <varlistentry>
4043 06 Dec 07 jari 279         <term>Plate mapping exporter</term>
4043 06 Dec 07 jari 280         <listitem>
4043 06 Dec 07 jari 281           <para>
4043 06 Dec 07 jari 282             Exports plate mappings.
4043 06 Dec 07 jari 283           </para>
4043 06 Dec 07 jari 284         </listitem>
4043 06 Dec 07 jari 285       </varlistentry>
4043 06 Dec 07 jari 286
4043 06 Dec 07 jari 287       <varlistentry>
4043 06 Dec 07 jari 288         <term>Plugin configuration exporter</term>
4043 06 Dec 07 jari 289         <listitem>
4043 06 Dec 07 jari 290           <para>
4487 08 Sep 08 jari 291             Exports plug-in configurations to an XML file.
4043 06 Dec 07 jari 292           </para>
4043 06 Dec 07 jari 293         </listitem>
4043 06 Dec 07 jari 294       </varlistentry>
4043 06 Dec 07 jari 295
4043 06 Dec 07 jari 296       <varlistentry>
4043 06 Dec 07 jari 297         <term>Table exporter</term>
4043 06 Dec 07 jari 298         <listitem>
4043 06 Dec 07 jari 299           <para>
5820 24 Oct 11 nicklas 300             Exports data from table listings in the web-interface to
5820 24 Oct 11 nicklas 301             a TAB-separated text file or XML file.
4043 06 Dec 07 jari 302           </para>
4043 06 Dec 07 jari 303         </listitem>
4043 06 Dec 07 jari 304       </varlistentry>
4043 06 Dec 07 jari 305
4043 06 Dec 07 jari 306     </variablelist>
4043 06 Dec 07 jari 307
4043 06 Dec 07 jari 308   </sect1>
4043 06 Dec 07 jari 309
4043 06 Dec 07 jari 310   <sect1 id="coreplugins.import">
4432 01 Sep 08 jari 311     <title>Core import plug-ins</title>
4043 06 Dec 07 jari 312
4431 01 Sep 08 jari 313     <para>
5035 29 Jul 09 martin 314       There are many import plug-ins in BASE. Their use are in most
4431 01 Sep 08 jari 315       cases seamless and the user does not need to be aware of
4431 01 Sep 08 jari 316       detailed plug-in usage. However, there is a set of batch import
4431 01 Sep 08 jari 317       plug-ins that are targeted for importing multiple items into
4431 01 Sep 08 jari 318       BASE. These batch importers require some user knowledge for
4431 01 Sep 08 jari 319       proper and efficient use of them. The batch plug-ins are listed
4431 01 Sep 08 jari 320       in the <xref linkend="coreplugins.import.batch" /> sub-section
4431 01 Sep 08 jari 321       below together with pointers to further reading on how to use
4431 01 Sep 08 jari 322       the plug-ins.
4431 01 Sep 08 jari 323     </para>
4431 01 Sep 08 jari 324
4043 06 Dec 07 jari 325     <variablelist>
4043 06 Dec 07 jari 326
4043 06 Dec 07 jari 327       <varlistentry>
4043 06 Dec 07 jari 328         <term>Affymetrix CDF probeset importer</term>
4043 06 Dec 07 jari 329         <listitem>
4043 06 Dec 07 jari 330           <para>
4043 06 Dec 07 jari 331             This plug-in is used to import probesets (reporters in
4043 06 Dec 07 jari 332             BASE language) from an Affymetrix CDF file. It can be used
4043 06 Dec 07 jari 333             in import mode from the reporter list view and from the
4043 06 Dec 07 jari 334             array design view and in verification mode from the array
4487 08 Sep 08 jari 335             design view. The plug-in can only set the name and ID of
4043 06 Dec 07 jari 336             the reporters, since the CDF file doesn't contains any
4043 06 Dec 07 jari 337             annotation information. Probesets already in BASE will not
5820 24 Oct 11 nicklas 338             be affected by the import. No configuration is needed.
4043 06 Dec 07 jari 339           </para>
4043 06 Dec 07 jari 340         </listitem>
4043 06 Dec 07 jari 341       </varlistentry>
4043 06 Dec 07 jari 342
4043 06 Dec 07 jari 343       <varlistentry>
4043 06 Dec 07 jari 344         <term>Annotation importer</term>
4043 06 Dec 07 jari 345         <listitem>
4043 06 Dec 07 jari 346           <para>
4487 08 Sep 08 jari 347             Imports annotation to any annotatable item in BASE.
5820 24 Oct 11 nicklas 348             Configurations are supported but not required.
4043 06 Dec 07 jari 349           </para>
5820 24 Oct 11 nicklas 350         </listitem>
5820 24 Oct 11 nicklas 351       </varlistentry>
5820 24 Oct 11 nicklas 352
5820 24 Oct 11 nicklas 353       <varlistentry>
5820 24 Oct 11 nicklas 354         <term>GTF reporter importer</term>
5820 24 Oct 11 nicklas 355         <listitem>
4043 06 Dec 07 jari 356           <para>
5820 24 Oct 11 nicklas 357             Imports reporter information from GTF (Gene transfer format)
5820 24 Oct 11 nicklas 358             files. Configurations are supported but not required. BASE
5820 24 Oct 11 nicklas 359             has pre-installed configurations that uses the gene_id or transcript_id
5820 24 Oct 11 nicklas 360             as reporter id.
4043 06 Dec 07 jari 361           </para>
4043 06 Dec 07 jari 362         </listitem>
4043 06 Dec 07 jari 363       </varlistentry>
4043 06 Dec 07 jari 364
4043 06 Dec 07 jari 365       <varlistentry>
5820 24 Oct 11 nicklas 366         <term>GTF reporter map importer</term>
4043 06 Dec 07 jari 367         <listitem>
4043 06 Dec 07 jari 368           <para>
5820 24 Oct 11 nicklas 369             Imports array design features from GTF (Gene transfer format)
5820 24 Oct 11 nicklas 370             files. A configuration is needed. BASE has pre-installed
5820 24 Oct 11 nicklas 371             configurations that uses the gene_id or transcript_id
5820 24 Oct 11 nicklas 372             as reporter id.
4043 06 Dec 07 jari 373           </para>
5820 24 Oct 11 nicklas 374         </listitem>
5820 24 Oct 11 nicklas 375       </varlistentry>
5820 24 Oct 11 nicklas 376
5820 24 Oct 11 nicklas 377       <varlistentry>
5820 24 Oct 11 nicklas 378         <term>Help texts importer</term>
5820 24 Oct 11 nicklas 379         <listitem>
4043 06 Dec 07 jari 380           <para>
5820 24 Oct 11 nicklas 381             Imports help texts from an XML file into BASE. 
5820 24 Oct 11 nicklas 382             No configuration is needed.
4043 06 Dec 07 jari 383           </para>
4043 06 Dec 07 jari 384         </listitem>
4043 06 Dec 07 jari 385       </varlistentry>
4043 06 Dec 07 jari 386
4043 06 Dec 07 jari 387       <varlistentry>
4043 06 Dec 07 jari 388         <term>Illumina raw data importer</term>
4043 06 Dec 07 jari 389         <listitem>
4043 06 Dec 07 jari 390           <para>
5820 24 Oct 11 nicklas 391             This plug-in is used to import raw data from Illumina BeadStudion
5820 24 Oct 11 nicklas 392             data files. No configuration is needed.
4043 06 Dec 07 jari 393           </para>
4043 06 Dec 07 jari 394         </listitem>
4043 06 Dec 07 jari 395       </varlistentry>
4043 06 Dec 07 jari 396
4043 06 Dec 07 jari 397       <varlistentry>
4043 06 Dec 07 jari 398         <term>Plate importer</term>
4043 06 Dec 07 jari 399         <listitem>
4043 06 Dec 07 jari 400           <para>
5820 24 Oct 11 nicklas 401             Imports plates from a simple flat file. A configuration is needed.
5820 24 Oct 11 nicklas 402             BASE has pre-installed configurations for 96- and 384-well plates.
4043 06 Dec 07 jari 403           </para>
4043 06 Dec 07 jari 404         </listitem>
4043 06 Dec 07 jari 405       </varlistentry>
4043 06 Dec 07 jari 406
4043 06 Dec 07 jari 407       <varlistentry>
4043 06 Dec 07 jari 408         <term>Plate mapping importer</term>
4043 06 Dec 07 jari 409         <listitem>
4043 06 Dec 07 jari 410           <para>
5820 24 Oct 11 nicklas 411             Imports plate mappings exported by the <emphasis>Plate mapping exporter</emphasis>.
5820 24 Oct 11 nicklas 412             No configuration is needed.
4043 06 Dec 07 jari 413           </para>
4043 06 Dec 07 jari 414         </listitem>
4043 06 Dec 07 jari 415       </varlistentry>
4043 06 Dec 07 jari 416
4043 06 Dec 07 jari 417               
4043 06 Dec 07 jari 418       <varlistentry>
4043 06 Dec 07 jari 419         <term>Plugin configuration importer</term>
4043 06 Dec 07 jari 420         <listitem>
4043 06 Dec 07 jari 421           <para>
5820 24 Oct 11 nicklas 422             Imports plug-in configurations from an XML file. No configuration
5820 24 Oct 11 nicklas 423             is needed.
4043 06 Dec 07 jari 424           </para>
4043 06 Dec 07 jari 425         </listitem>
4043 06 Dec 07 jari 426       </varlistentry>
4043 06 Dec 07 jari 427
4043 06 Dec 07 jari 428       <varlistentry>
4043 06 Dec 07 jari 429         <term>Print map importer</term>
4043 06 Dec 07 jari 430         <listitem>
4043 06 Dec 07 jari 431           <para>
5820 24 Oct 11 nicklas 432             Imports array design features from TAM or MwBR files. This plug-in
5820 24 Oct 11 nicklas 433             require that the array design is connected with plates. No
5820 24 Oct 11 nicklas 434             configuration is needed.
4043 06 Dec 07 jari 435           </para>
4043 06 Dec 07 jari 436         </listitem>
4043 06 Dec 07 jari 437       </varlistentry>
4043 06 Dec 07 jari 438
4043 06 Dec 07 jari 439       <varlistentry>
4043 06 Dec 07 jari 440         <term>Raw data importer</term>
4043 06 Dec 07 jari 441         <listitem>
4043 06 Dec 07 jari 442           <para>
5820 24 Oct 11 nicklas 443             Imports raw data from a text file. A configuration is needed. 
5820 24 Oct 11 nicklas 444             BASE has pre-installed configurations for GenePix and Cufflinks
5820 24 Oct 11 nicklas 445             data files.
4043 06 Dec 07 jari 446           </para>
4043 06 Dec 07 jari 447         </listitem>
4043 06 Dec 07 jari 448       </varlistentry>
4043 06 Dec 07 jari 449
4043 06 Dec 07 jari 450       <varlistentry>
4043 06 Dec 07 jari 451         <term>Reporter importer</term>
4043 06 Dec 07 jari 452         <listitem>
4043 06 Dec 07 jari 453           <para>
5820 24 Oct 11 nicklas 454             Import reporter (probeset) information from a file. A configuration
5820 24 Oct 11 nicklas 455             is not needed, but is recommended. BASE has pre-installed configurations
5820 24 Oct 11 nicklas 456             for several different file types.
4043 06 Dec 07 jari 457           </para>
4043 06 Dec 07 jari 458           <para>
4043 06 Dec 07 jari 459             <emphasis>Since BASE 2.0, available
4043 06 Dec 07 jari 460             configurations:</emphasis>
4043 06 Dec 07 jari 461           </para>
4043 06 Dec 07 jari 462         </listitem>
4043 06 Dec 07 jari 463       </varlistentry>
4043 06 Dec 07 jari 464
4043 06 Dec 07 jari 465       <varlistentry>
4043 06 Dec 07 jari 466         <term>Reporter map importer</term>
4043 06 Dec 07 jari 467         <listitem>
4043 06 Dec 07 jari 468           <para>
5820 24 Oct 11 nicklas 469             Imports array design features from text files. This plug-in can
5820 24 Oct 11 nicklas 470             be used without connection to plates. A configuration is needed.
5820 24 Oct 11 nicklas 471             BASE has pre-installed configurations for some file formats.
4043 06 Dec 07 jari 472           </para>
4043 06 Dec 07 jari 473         </listitem>
4043 06 Dec 07 jari 474       </varlistentry>
4043 06 Dec 07 jari 475
4043 06 Dec 07 jari 476     </variablelist>
4043 06 Dec 07 jari 477
4431 01 Sep 08 jari 478     <sect2 id="coreplugins.import.batch">
4432 01 Sep 08 jari 479       <title>Core batch import plug-ins</title>
4431 01 Sep 08 jari 480
4431 01 Sep 08 jari 481       <para>
4431 01 Sep 08 jari 482         The batch import plug-ins all work similarly and their usage
5820 24 Oct 11 nicklas 483         is described in <xref linkend="import_data.batch" />. All
5820 24 Oct 11 nicklas 484         batch importers have support for configurations but can also
5820 24 Oct 11 nicklas 485         be used without.
4431 01 Sep 08 jari 486       </para>
4431 01 Sep 08 jari 487
4431 01 Sep 08 jari 488       <variablelist>
4434 02 Sep 08 nicklas 489         <varlistentry>
4434 02 Sep 08 nicklas 490           <term>Array batch importer</term>
4434 02 Sep 08 nicklas 491           <listitem>
4434 02 Sep 08 nicklas 492             <para>
4434 02 Sep 08 nicklas 493               Imports and updates array batches in a batch.
4434 02 Sep 08 nicklas 494             </para>
4434 02 Sep 08 nicklas 495           </listitem>
4434 02 Sep 08 nicklas 496         </varlistentry>
4434 02 Sep 08 nicklas 497   
4434 02 Sep 08 nicklas 498         <varlistentry>
4434 02 Sep 08 nicklas 499           <term>Array design importer</term>
4434 02 Sep 08 nicklas 500           <listitem>
4434 02 Sep 08 nicklas 501             <para>
4434 02 Sep 08 nicklas 502               Imports and updates array designs in a batch.
4434 02 Sep 08 nicklas 503             </para>
4434 02 Sep 08 nicklas 504           </listitem>
4434 02 Sep 08 nicklas 505         </varlistentry>
4434 02 Sep 08 nicklas 506         
4434 02 Sep 08 nicklas 507         <varlistentry>
4434 02 Sep 08 nicklas 508           <term>Array slide importer</term>
4434 02 Sep 08 nicklas 509           <listitem>
4434 02 Sep 08 nicklas 510             <para>
4434 02 Sep 08 nicklas 511               Imports and updates array slides in a batch.
4434 02 Sep 08 nicklas 512             </para>
5820 24 Oct 11 nicklas 513           </listitem>
5820 24 Oct 11 nicklas 514         </varlistentry>
5820 24 Oct 11 nicklas 515
5820 24 Oct 11 nicklas 516         <varlistentry>
5820 24 Oct 11 nicklas 517           <term>Bioplate importer</term>
5820 24 Oct 11 nicklas 518           <listitem>
4434 02 Sep 08 nicklas 519             <para>
5820 24 Oct 11 nicklas 520               Imports and updates bioplates in a batch. Note that this
5820 24 Oct 11 nicklas 521               import can't be used to put biomaterial on the bioplates.
4434 02 Sep 08 nicklas 522             </para>
4434 02 Sep 08 nicklas 523           </listitem>
4434 02 Sep 08 nicklas 524         </varlistentry>
4431 01 Sep 08 jari 525
4431 01 Sep 08 jari 526         <varlistentry>
4431 01 Sep 08 jari 527           <term>Biosource importer</term>
4431 01 Sep 08 jari 528           <listitem>
4431 01 Sep 08 jari 529             <para>
4431 01 Sep 08 jari 530               Imports and updates biosources in a batch.
4431 01 Sep 08 jari 531             </para>
4431 01 Sep 08 jari 532           </listitem>
4431 01 Sep 08 jari 533         </varlistentry>
4431 01 Sep 08 jari 534
4431 01 Sep 08 jari 535         <varlistentry>
5820 24 Oct 11 nicklas 536           <term>Derived bioassay importer</term>
4431 01 Sep 08 jari 537           <listitem>
4431 01 Sep 08 jari 538             <para>
5820 24 Oct 11 nicklas 539               Imports and updates derived bioassays in a batch.
4431 01 Sep 08 jari 540             </para>
4431 01 Sep 08 jari 541           </listitem>
4431 01 Sep 08 jari 542         </varlistentry>
4431 01 Sep 08 jari 543
4431 01 Sep 08 jari 544         <varlistentry>
5820 24 Oct 11 nicklas 545           <term>Extract importer</term>
4431 01 Sep 08 jari 546           <listitem>
4431 01 Sep 08 jari 547             <para>
5820 24 Oct 11 nicklas 548               Imports and updates extracts in a batch.
4431 01 Sep 08 jari 549             </para>
4431 01 Sep 08 jari 550           </listitem>
4431 01 Sep 08 jari 551         </varlistentry>
4431 01 Sep 08 jari 552
4431 01 Sep 08 jari 553         <varlistentry>
5820 24 Oct 11 nicklas 554           <term>Physical bioassay importer</term>
4431 01 Sep 08 jari 555           <listitem>
4431 01 Sep 08 jari 556             <para>
5820 24 Oct 11 nicklas 557               Imports and updates physical bioassays in a batch.
4431 01 Sep 08 jari 558             </para>
4431 01 Sep 08 jari 559           </listitem>
4431 01 Sep 08 jari 560         </varlistentry>
4431 01 Sep 08 jari 561
4431 01 Sep 08 jari 562         <varlistentry>
4431 01 Sep 08 jari 563           <term>Raw bioassay importer</term>
4431 01 Sep 08 jari 564           <listitem>
4431 01 Sep 08 jari 565             <para>
4431 01 Sep 08 jari 566               Imports and updates raw bioassays in a batch.
4431 01 Sep 08 jari 567             </para>
4431 01 Sep 08 jari 568           </listitem>
4431 01 Sep 08 jari 569         </varlistentry>
4431 01 Sep 08 jari 570
4431 01 Sep 08 jari 571         <varlistentry>
4431 01 Sep 08 jari 572           <term>Sample importer</term>
4431 01 Sep 08 jari 573           <listitem>
4431 01 Sep 08 jari 574             <para>
4431 01 Sep 08 jari 575               Imports and updates samples in a batch.
4431 01 Sep 08 jari 576             </para>
4431 01 Sep 08 jari 577           </listitem>
4431 01 Sep 08 jari 578         </varlistentry>
4431 01 Sep 08 jari 579
4431 01 Sep 08 jari 580       </variablelist>
4431 01 Sep 08 jari 581
4431 01 Sep 08 jari 582     </sect2>
4431 01 Sep 08 jari 583
4043 06 Dec 07 jari 584   </sect1>
4043 06 Dec 07 jari 585
4043 06 Dec 07 jari 586   <sect1 id="coreplugins.intensity">
4432 01 Sep 08 jari 587     <title>Core intensity plug-ins</title>
4043 06 Dec 07 jari 588
4043 06 Dec 07 jari 589     <variablelist>
4043 06 Dec 07 jari 590       <varlistentry>
4043 06 Dec 07 jari 591         <term>Formula intensity calculator</term>
4043 06 Dec 07 jari 592         <listitem>
4043 06 Dec 07 jari 593           <para>
5820 24 Oct 11 nicklas 594             Calculate intensities from raw data using a user-defined formula.
5820 24 Oct 11 nicklas 595             No configuration is needed, but formulas must be defined using
5820 24 Oct 11 nicklas 596             <menuchoice>
5820 24 Oct 11 nicklas 597               <guimenu>View</guimenu>
5820 24 Oct 11 nicklas 598               <guimenuitem>Formulas</guimenuitem>
5820 24 Oct 11 nicklas 599             </menuchoice>.
4043 06 Dec 07 jari 600           </para>
4043 06 Dec 07 jari 601         </listitem>
4043 06 Dec 07 jari 602       </varlistentry>
4043 06 Dec 07 jari 603
4043 06 Dec 07 jari 604     </variablelist>
4043 06 Dec 07 jari 605
4043 06 Dec 07 jari 606   </sect1>
4043 06 Dec 07 jari 607
4043 06 Dec 07 jari 608   <sect1 id="coreplugins.other">
4432 01 Sep 08 jari 609     <title>Uncategorized core plug-ins</title>
4043 06 Dec 07 jari 610
4043 06 Dec 07 jari 611     <variablelist>
4043 06 Dec 07 jari 612
4043 06 Dec 07 jari 613       <varlistentry>
4043 06 Dec 07 jari 614         <term>TAR file unpacker</term>
4043 06 Dec 07 jari 615         <listitem>
4043 06 Dec 07 jari 616           <para>
4043 06 Dec 07 jari 617             Unpacks a tar file on the BASE file system. It also
4043 06 Dec 07 jari 618             supports TAR files compressed with GZIP or BZIP
5820 24 Oct 11 nicklas 619             algorithms. This plug-in can be used to automatically
5820 24 Oct 11 nicklas 620             unpack files during upload. No configuration is needed.
4043 06 Dec 07 jari 621           </para>
4043 06 Dec 07 jari 622         </listitem>
4043 06 Dec 07 jari 623       </varlistentry>
4043 06 Dec 07 jari 624
4043 06 Dec 07 jari 625       <varlistentry>
4043 06 Dec 07 jari 626         <term>ZIP file unpacker</term>
4043 06 Dec 07 jari 627         <listitem>
4043 06 Dec 07 jari 628           <para>
5820 24 Oct 11 nicklas 629             Unpacks ZIP and JAR files on the BASE's file system. 
5820 24 Oct 11 nicklas 630             This plug-in can be used to automatically unpack files 
5820 24 Oct 11 nicklas 631             during upload. No configuration is needed.
4043 06 Dec 07 jari 632           </para>
4043 06 Dec 07 jari 633         </listitem>
4043 06 Dec 07 jari 634       </varlistentry>
4043 06 Dec 07 jari 635
6049 18 Apr 12 nicklas 636       <varlistentry>
6049 18 Apr 12 nicklas 637         <term>BZip2 file unpacker</term>
6049 18 Apr 12 nicklas 638         <listitem>
6049 18 Apr 12 nicklas 639           <para>
6049 18 Apr 12 nicklas 640             Unpacks BZip2 compressed files to the BASE file
6049 18 Apr 12 nicklas 641             system. This plug-in can be used to automatically unpack files 
6049 18 Apr 12 nicklas 642             during upload. No configuration is needed.
6049 18 Apr 12 nicklas 643           </para>
6049 18 Apr 12 nicklas 644         </listitem>
6049 18 Apr 12 nicklas 645       </varlistentry>
6049 18 Apr 12 nicklas 646       
6049 18 Apr 12 nicklas 647       <varlistentry>
6049 18 Apr 12 nicklas 648         <term>GZip file unpacker</term>
6049 18 Apr 12 nicklas 649         <listitem>
6049 18 Apr 12 nicklas 650           <para>
6049 18 Apr 12 nicklas 651             Unpacks GZip compressed files to the BASE file
6049 18 Apr 12 nicklas 652             system. This plug-in can be used to automatically unpack files 
6049 18 Apr 12 nicklas 653             during upload. No configuration is needed.
6049 18 Apr 12 nicklas 654           </para>
6049 18 Apr 12 nicklas 655         </listitem>
6049 18 Apr 12 nicklas 656       </varlistentry>
6049 18 Apr 12 nicklas 657
4043 06 Dec 07 jari 658     </variablelist>
4043 06 Dec 07 jari 659
4043 06 Dec 07 jari 660   </sect1>
4043 06 Dec 07 jari 661
3334 14 May 07 nicklas 662 </appendix>
3334 14 May 07 nicklas 663