doc/src/docbook/user/reporters.xml

Code
Comments
Other
Rev Date Author Line
3157 05 Mar 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3159 05 Mar 07 martin 2 <!DOCTYPE chapter PUBLIC 
3159 05 Mar 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3192 13 Mar 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3403 29 May 07 nicklas 5 <!--
3403 29 May 07 nicklas 6   $Id$
3403 29 May 07 nicklas 7   
3675 16 Aug 07 jari 8   Copyright (C) 2007 Peter Johansson, Nicklas Nordborg, Philippe Rocca-Serra, Martin Svensson
4889 06 Apr 09 nicklas 9   Copyright (C) 2008 Jari Häkkinen
3403 29 May 07 nicklas 10   
3403 29 May 07 nicklas 11   This file is part of BASE - BioArray Software Environment.
3403 29 May 07 nicklas 12   Available at http://base.thep.lu.se/
3403 29 May 07 nicklas 13   
3403 29 May 07 nicklas 14   BASE is free software; you can redistribute it and/or
3403 29 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
3403 29 May 07 nicklas 17   of the License, or (at your option) any later version.
3403 29 May 07 nicklas 18   
3403 29 May 07 nicklas 19   BASE is distributed in the hope that it will be useful,
3403 29 May 07 nicklas 20   but WITHOUT ANY WARRANTY; without even the implied warranty of
3403 29 May 07 nicklas 21   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3403 29 May 07 nicklas 22   GNU General Public License for more details.
3403 29 May 07 nicklas 23   
3403 29 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/>.
3403 29 May 07 nicklas 26 -->
3403 29 May 07 nicklas 27 <chapter id="reporters" chunked="0">
3403 29 May 07 nicklas 28   <title>Reporters</title>
5795 10 Oct 11 nicklas 29   
3403 29 May 07 nicklas 30     <helptext external_id="reporter.view.properties" 
3403 29 May 07 nicklas 31       title="About reporters">
3403 29 May 07 nicklas 32     <para>
3403 29 May 07 nicklas 33       Reporter, a term coined by the MAGE object model refers to
3403 29 May 07 nicklas 34       spotted DNA sequence on a microarray. Reporters are
3403 29 May 07 nicklas 35       therefore usually described by a sequence and a series of
3403 29 May 07 nicklas 36       database identifiers qualifying that sequence. Reporters are
3403 29 May 07 nicklas 37       generally understood as the thing biologists are interested
3403 29 May 07 nicklas 38       in when carrying out DNA microarray experiments.
3403 29 May 07 nicklas 39     </para>
3403 29 May 07 nicklas 40     <para>
4487 08 Sep 08 jari 41       In BASE, reporters also refer to Affymetrix Probeset ID but
3403 29 May 07 nicklas 42       reporters can be used to describe genes, transcripts, exons
3403 29 May 07 nicklas 43       or any other sequence entity of biological relevance.
3403 29 May 07 nicklas 44     </para>
3403 29 May 07 nicklas 45     </helptext>
3403 29 May 07 nicklas 46   
3403 29 May 07 nicklas 47   <sect1 id="reportertypes">
3403 29 May 07 nicklas 48     <title>Reporter types</title>
3403 29 May 07 nicklas 49     
3403 29 May 07 nicklas 50     <helptext external_id="reportertype.view.properties" 
3403 29 May 07 nicklas 51       title="About reporter types">
3403 29 May 07 nicklas 52     <para>
3403 29 May 07 nicklas 53       <guilabel>Reporter Type</guilabel>
3403 29 May 07 nicklas 54       allows classification of reporters based on their usage
3403 29 May 07 nicklas 55       and qualification defined during the array design
3403 29 May 07 nicklas 56       specification.
5795 10 Oct 11 nicklas 57       <nohelp>
3403 29 May 07 nicklas 58       You can manage the reporter types by going to
3403 29 May 07 nicklas 59       <menuchoice>
3403 29 May 07 nicklas 60         <guimenu>Administrate</guimenu>
3403 29 May 07 nicklas 61         <guimenuitem>Types</guimenuitem>
3403 29 May 07 nicklas 62         <guisubmenu>Reporter types</guisubmenu>
3403 29 May 07 nicklas 63       </menuchoice>.
5795 10 Oct 11 nicklas 64       </nohelp>
3403 29 May 07 nicklas 65     </para>
5795 10 Oct 11 nicklas 66     </helptext>
3403 29 May 07 nicklas 67     
3403 29 May 07 nicklas 68     <figure
3405 29 May 07 nicklas 69       id="reporterstypes.figures.properties">
3403 29 May 07 nicklas 70       <title>Reporter type properties</title>
3403 29 May 07 nicklas 71       <screenshot>
3403 29 May 07 nicklas 72         <mediaobject>
3403 29 May 07 nicklas 73           <imageobject>
3403 29 May 07 nicklas 74             <imagedata
3403 29 May 07 nicklas 75               fileref="figures/reportertype.png" format="PNG" />
3403 29 May 07 nicklas 76           </imageobject>
3403 29 May 07 nicklas 77         </mediaobject>
3403 29 May 07 nicklas 78       </screenshot>
3403 29 May 07 nicklas 79     </figure>
3403 29 May 07 nicklas 80     
3403 29 May 07 nicklas 81     <helptext external_id="reportertype.edit" 
3403 29 May 07 nicklas 82       title="Reporter type properties">
3403 29 May 07 nicklas 83       
3403 29 May 07 nicklas 84       <variablelist>
3403 29 May 07 nicklas 85       <varlistentry>
3403 29 May 07 nicklas 86         <term><guilabel>Name</guilabel></term>
3403 29 May 07 nicklas 87         <listitem>
3403 29 May 07 nicklas 88           <para>
3403 29 May 07 nicklas 89           The name of the reporter type. It is advised to define the name
3403 29 May 07 nicklas 90           so that it is compatible with the
3403 29 May 07 nicklas 91           <ulink url="http://www.mged.org/Workgroups/MIAME/miame.html"
3403 29 May 07 nicklas 92             >MIAME requirements</ulink>
3403 29 May 07 nicklas 93           and recommendations issues by microarray data
3403 29 May 07 nicklas 94           repositories. Alternately, the local reporter type
3403 29 May 07 nicklas 95           could be submitted to those repositories for term
3403 29 May 07 nicklas 96           inclusion.
3403 29 May 07 nicklas 97           </para>
3403 29 May 07 nicklas 98         </listitem>
3403 29 May 07 nicklas 99       </varlistentry>
3403 29 May 07 nicklas 100       <varlistentry>
3403 29 May 07 nicklas 101         <term><guilabel>Description</guilabel></term>
3403 29 May 07 nicklas 102         <listitem>
3403 29 May 07 nicklas 103           <para>
3403 29 May 07 nicklas 104           A description of the reporter type.
3403 29 May 07 nicklas 105           </para>
3403 29 May 07 nicklas 106         </listitem>
3403 29 May 07 nicklas 107       </varlistentry>
3403 29 May 07 nicklas 108       </variablelist>
3403 29 May 07 nicklas 109     </helptext>
3403 29 May 07 nicklas 110     
3403 29 May 07 nicklas 111   </sect1>
3157 05 Mar 07 martin 112
3157 05 Mar 07 martin 113
3403 29 May 07 nicklas 114   <sect1 id="reporter.manage">
3403 29 May 07 nicklas 115     <title>Reporters</title>
3403 29 May 07 nicklas 116     
3403 29 May 07 nicklas 117     <para>
3403 29 May 07 nicklas 118       Go to
3403 29 May 07 nicklas 119       <menuchoice>
3403 29 May 07 nicklas 120         <guimenu>View</guimenu>
5795 10 Oct 11 nicklas 121         <guimenuitem>Reporters</guimenuitem>
3403 29 May 07 nicklas 122       </menuchoice> to view and manage the reporters.
3403 29 May 07 nicklas 123     </para>
3403 29 May 07 nicklas 124     
3403 29 May 07 nicklas 125     <sect2 id="reporters.import">
3403 29 May 07 nicklas 126       <title>Import/update reporter from files</title>
3403 29 May 07 nicklas 127       
3403 29 May 07 nicklas 128       <para>
3403 29 May 07 nicklas 129         Reporters are used to represent genes, transcripts,
3403 29 May 07 nicklas 130         exons and therefore come in their thousands. To solve
4487 08 Sep 08 jari 131         this problem, BASE relies on
3403 29 May 07 nicklas 132         <emphasis>Reporter import plug-ins</emphasis>.
3403 29 May 07 nicklas 133         Those need to be specifically configured to deal with
3403 29 May 07 nicklas 134         a particular input file format. This input file can be
3403 29 May 07 nicklas 135         typically be an Axon GAL file or an Affymetrix CSV file
3403 29 May 07 nicklas 136         which both provide information about reporters and their
4432 01 Sep 08 jari 137         annotations. See <xref linkend="import_data" />
3403 29 May 07 nicklas 138         for more information about importing and <xref 
3403 29 May 07 nicklas 139         linkend="plugins.configuration" />
3403 29 May 07 nicklas 140         for more information about configuring file formats.
3403 29 May 07 nicklas 141       </para>
3403 29 May 07 nicklas 142       
3403 29 May 07 nicklas 143       <note>
3403 29 May 07 nicklas 144         <title>Dealing with Affymetrix probesets</title>
3403 29 May 07 nicklas 145         <para>
4487 08 Sep 08 jari 146         In BASE, Affymetrix probesets should be treated as reporters.
3403 29 May 07 nicklas 147         The probeset ID could be stored in both the
3403 29 May 07 nicklas 148         <guilabel>Name</guilabel> and the <guilabel>External ID</guilabel>
3403 29 May 07 nicklas 149         fields of the reporter table.
3403 29 May 07 nicklas 150         Storing the probeset ID should be enough
3403 29 May 07 nicklas 151         as most analysis tools allow retrieval of updated
3403 29 May 07 nicklas 152         information based on the probeset ID from
3403 29 May 07 nicklas 153         web resources.
3403 29 May 07 nicklas 154         </para>
4403 21 Aug 08 jari 155         <para>
4403 21 Aug 08 jari 156           For some Affymetrix chips the associated CSV file does not
4403 21 Aug 08 jari 157           list all reporters on the actual chip. This will lead to
4403 21 Aug 08 jari 158           problems in later use of the affected chip types. Simply use
4403 21 Aug 08 jari 159           the associated CDF file to import the missing probesets into
4403 21 Aug 08 jari 160           BASE, make sure not to upgrade existing reporters when
5706 23 Aug 11 nicklas 161           starting the plug-in.
4403 21 Aug 08 jari 162         </para>
3403 29 May 07 nicklas 163       </note>
3403 29 May 07 nicklas 164       
3403 29 May 07 nicklas 165     </sect2>
3403 29 May 07 nicklas 166     
3403 29 May 07 nicklas 167     <sect2 id="reporters.create">
3403 29 May 07 nicklas 168       <title>Manual management of reporters</title>
3403 29 May 07 nicklas 169       
3403 29 May 07 nicklas 170       <para>
3403 29 May 07 nicklas 171         Reporters can also be created or edited manually
3403 29 May 07 nicklas 172         one-by-one. This follows the same pattern as for 
3403 29 May 07 nicklas 173         all other items and is described in general terms
3403 29 May 07 nicklas 174         in <xref linkend="webclient.items"/>.
3403 29 May 07 nicklas 175       </para>
3403 29 May 07 nicklas 176       
3403 29 May 07 nicklas 177         <figure id="reporters.figures.properties">
3403 29 May 07 nicklas 178           <title>Reporter properties</title>
3403 29 May 07 nicklas 179           <screenshot>
3403 29 May 07 nicklas 180             <mediaobject>
3403 29 May 07 nicklas 181               <imageobject>
3403 29 May 07 nicklas 182                 <imagedata fileref="figures/reporter-1.png" format="PNG" />
3403 29 May 07 nicklas 183               </imageobject>
3403 29 May 07 nicklas 184             </mediaobject>
3403 29 May 07 nicklas 185           </screenshot>
3403 29 May 07 nicklas 186         </figure>
3403 29 May 07 nicklas 187         
3403 29 May 07 nicklas 188         <helptext external_id="reporter.edit" 
3403 29 May 07 nicklas 189           title="Reporer properties">
3403 29 May 07 nicklas 190           
3403 29 May 07 nicklas 191           <para>
3403 29 May 07 nicklas 192             This tab shows core information that would be
3403 29 May 07 nicklas 193             common to all BASE instances.
3403 29 May 07 nicklas 194           </para>
3403 29 May 07 nicklas 195           
3403 29 May 07 nicklas 196           <variablelist>
3403 29 May 07 nicklas 197           <varlistentry>
3403 29 May 07 nicklas 198             <term><guilabel>Name</guilabel></term>
3403 29 May 07 nicklas 199             <listitem>
3403 29 May 07 nicklas 200               <para>
3403 29 May 07 nicklas 201               The name of the reporter. This is often the same 
3403 29 May 07 nicklas 202               as the <guilabel>External ID</guilabel>.
3403 29 May 07 nicklas 203               </para>
3403 29 May 07 nicklas 204             </listitem>
3403 29 May 07 nicklas 205           </varlistentry>
3403 29 May 07 nicklas 206           <varlistentry>
3403 29 May 07 nicklas 207             <term><guilabel>External ID</guilabel></term>
3403 29 May 07 nicklas 208             <listitem>
3403 29 May 07 nicklas 209               <para>
3403 29 May 07 nicklas 210               The external ID of the reporter as it is defined in
3403 29 May 07 nicklas 211               some database. The ID must be unique within BASE. The
3403 29 May 07 nicklas 212               external ID is what plug-ins uses to match reporter 
3403 29 May 07 nicklas 213               information found in raw data files, array design files, 
3403 29 May 07 nicklas 214               etc.
3403 29 May 07 nicklas 215               </para>
3403 29 May 07 nicklas 216             </listitem>
3403 29 May 07 nicklas 217           </varlistentry>
3403 29 May 07 nicklas 218           <varlistentry>
3403 29 May 07 nicklas 219             <term><guilabel>Type</guilabel></term>
3403 29 May 07 nicklas 220             <listitem>
3403 29 May 07 nicklas 221               <para>
3403 29 May 07 nicklas 222               Optionally select a reporter type.
3403 29 May 07 nicklas 223               </para>
3403 29 May 07 nicklas 224             </listitem>
3403 29 May 07 nicklas 225           </varlistentry>
3403 29 May 07 nicklas 226           <varlistentry>
3403 29 May 07 nicklas 227             <term><guilabel>Gene symbol</guilabel></term>
3403 29 May 07 nicklas 228             <listitem>
3403 29 May 07 nicklas 229               <para>
3403 29 May 07 nicklas 230               The gene this reporter represents.
3403 29 May 07 nicklas 231               </para>
3403 29 May 07 nicklas 232             </listitem>
3403 29 May 07 nicklas 233           </varlistentry>
3403 29 May 07 nicklas 234           </variablelist>
3403 29 May 07 nicklas 235           
3403 29 May 07 nicklas 236           <seeother>
3403 29 May 07 nicklas 237             <other external_id="reporter.view.properties">About reporters</other>
3403 29 May 07 nicklas 238             <other external_id="reporter.edit.extended">Extended properties</other>
3403 29 May 07 nicklas 239           </seeother>
3403 29 May 07 nicklas 240         </helptext>
5795 10 Oct 11 nicklas 241
3403 29 May 07 nicklas 242         <figure id="reporters.figures.extended_properties">
3403 29 May 07 nicklas 243           <title>Extended reporter properties</title>
3403 29 May 07 nicklas 244           <screenshot>
3403 29 May 07 nicklas 245             <mediaobject>
3403 29 May 07 nicklas 246               <imageobject>
3403 29 May 07 nicklas 247                 <imagedata fileref="figures/reporter-2.png" format="PNG" />
3403 29 May 07 nicklas 248               </imageobject>
3403 29 May 07 nicklas 249             </mediaobject>
3403 29 May 07 nicklas 250           </screenshot>
3403 29 May 07 nicklas 251         </figure>
3403 29 May 07 nicklas 252         
3403 29 May 07 nicklas 253         <helptext external_id="reporter.edit.extended" 
3403 29 May 07 nicklas 254           title="Extended reporter properties">
3403 29 May 07 nicklas 255         
3403 29 May 07 nicklas 256           <para>
3403 29 May 07 nicklas 257             Reporters belong to a special class whose properties 
3403 29 May 07 nicklas 258             can be defined and extended by system
3403 29 May 07 nicklas 259             administrators. This is done by modifying the
3403 29 May 07 nicklas 260             <filename>extended-properties.xml</filename> file during 
3403 29 May 07 nicklas 261             database configuration or upgrade. All fields on
3403 29 May 07 nicklas 262             this tab are automatically generated based on this 
3403 29 May 07 nicklas 263             configuration and can be different from one server
3403 29 May 07 nicklas 264             to the next.      
3403 29 May 07 nicklas 265             <nohelp>
5738 15 Sep 11 nicklas 266             See <xref linkend="installation.main" />
3403 29 May 07 nicklas 267             and <xref linkend="appendix.extendedproperties" />
3403 29 May 07 nicklas 268             for more information.
3403 29 May 07 nicklas 269             </nohelp>
3403 29 May 07 nicklas 270             
3403 29 May 07 nicklas 271             <note>
3403 29 May 07 nicklas 272               <para>
3403 29 May 07 nicklas 273                 It is possible to configure the extended properties
3403 29 May 07 nicklas 274                 so that links to the primary external databases can
3403 29 May 07 nicklas 275                 be made. For example, the <guilabel>Cluster ID</guilabel>
3403 29 May 07 nicklas 276                 is linked to the <ulink 
3403 29 May 07 nicklas 277                   url="http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?db=unigene"
4487 08 Sep 08 jari 278                   >UniGene database at NCBI</ulink>.
3403 29 May 07 nicklas 279               </para>
3403 29 May 07 nicklas 280             </note>
3403 29 May 07 nicklas 281           </para>
3403 29 May 07 nicklas 282         
3403 29 May 07 nicklas 283           <seeother>
3403 29 May 07 nicklas 284             <other external_id="reporter.edit">Reporter properties</other>
3403 29 May 07 nicklas 285           </seeother>
3403 29 May 07 nicklas 286         </helptext>
3403 29 May 07 nicklas 287     </sect2>
3403 29 May 07 nicklas 288  
3157 05 Mar 07 martin 289
3403 29 May 07 nicklas 290     <sect2 id="reporter.delete">
3403 29 May 07 nicklas 291       <title>Deleting reporters</title>
3403 29 May 07 nicklas 292       
5795 10 Oct 11 nicklas 293       <caution>
3487 13 Jun 07 peter 294         <title>Deleted reporters cannot be restored</title>
3403 29 May 07 nicklas 295         <para>
3403 29 May 07 nicklas 296           Reporters are treated differently from other
3403 29 May 07 nicklas 297           items (e.g biosources or protocols) since they
3840 16 Oct 07 jari 298           does not use the trashcan mechanism (see
3840 16 Oct 07 jari 299           <xref linkend="webclient.trashcan" />).
3403 29 May 07 nicklas 300           The deletion happens immediately and is an unrecoverable
3403 29 May 07 nicklas 301           event. BASE will always show a warning message which you must
3403 29 May 07 nicklas 302           confirm before the reporters are deleted.
3403 29 May 07 nicklas 303         </para>
5795 10 Oct 11 nicklas 304       </caution>
3403 29 May 07 nicklas 305       
3403 29 May 07 nicklas 306       <para>
3596 24 Jul 07 nicklas 307         Reporters which has been referenced to from reporter lists, raw data, array
3487 13 Jun 07 peter 308         designs, plates or any other item cannot be deleted.
3403 29 May 07 nicklas 309       </para>
3596 24 Jul 07 nicklas 310       
3596 24 Jul 07 nicklas 311       <sect3 id="reporter.delete.batch">
3596 24 Jul 07 nicklas 312         <title>Batch deletion</title>
3596 24 Jul 07 nicklas 313         <para>
4403 21 Aug 08 jari 314           A common problem is to delete reporters that has been accidentally
3596 24 Jul 07 nicklas 315           created. The regular web interface is usually no good since it
5706 23 Aug 11 nicklas 316           only allows you to delete a limited number of reporters at a time. To solve
3596 24 Jul 07 nicklas 317           this problem the reporter import plug-in can be used in delete mode.
3596 24 Jul 07 nicklas 318           You can use the same file as you used when importing. Just select
3596 24 Jul 07 nicklas 319           the <userinput>delete</userinput> option for the <guilabel>mode</guilabel>
3596 24 Jul 07 nicklas 320           parameter in the configuration wizard and continue as usual. 
3596 24 Jul 07 nicklas 321           If the plug-in is used in delete mode from a reporter list it will
3596 24 Jul 07 nicklas 322           only remove the reporters from the reporter list. The reporters are not
3596 24 Jul 07 nicklas 323           deleted from the database.
3596 24 Jul 07 nicklas 324         </para>
3596 24 Jul 07 nicklas 325         
3596 24 Jul 07 nicklas 326         <note>
3596 24 Jul 07 nicklas 327           <para>
3596 24 Jul 07 nicklas 328           It may be a bit confusing to delete things from an import plug-in. But
3596 24 Jul 07 nicklas 329           since plug-ins can only belong to one category and we wanted to re-use
3596 24 Jul 07 nicklas 330           existing file format definitions this was our only option.
3596 24 Jul 07 nicklas 331           </para>
3596 24 Jul 07 nicklas 332         </note>
3596 24 Jul 07 nicklas 333       </sect3>
3596 24 Jul 07 nicklas 334       
3403 29 May 07 nicklas 335     </sect2>
3157 05 Mar 07 martin 336
3403 29 May 07 nicklas 337   </sect1>
3157 05 Mar 07 martin 338
3403 29 May 07 nicklas 339   <sect1 id="reporterlists">
3403 29 May 07 nicklas 340     <title>Reporter lists</title>
3403 29 May 07 nicklas 341     <para>
4487 08 Sep 08 jari 342       BASE allows for defining sets of reporters for a
3403 29 May 07 nicklas 343       particular use, for instance to define a list of
5706 23 Aug 11 nicklas 344       reporters to be used on an array. There are several ways to do
3403 29 May 07 nicklas 345       so:
3403 29 May 07 nicklas 346     </para>
5706 23 Aug 11 nicklas 347     <itemizedlist>
3403 29 May 07 nicklas 348       <listitem>
3403 29 May 07 nicklas 349         <para>
3403 29 May 07 nicklas 350           Use the <guibutton>New reporter list</guibutton> button on the 
3403 29 May 07 nicklas 351           <menuchoice>
3403 29 May 07 nicklas 352             <guimenu>View</guimenu>
3403 29 May 07 nicklas 353             <guimenuitem>Reporters</guimenuitem>
5706 23 Aug 11 nicklas 354           </menuchoice> page. This creates a reporter list with the current
5706 23 Aug 11 nicklas 355           selection or filtered out reporters.
3403 29 May 07 nicklas 356         </para>
3403 29 May 07 nicklas 357       </listitem>
3403 29 May 07 nicklas 358       
3403 29 May 07 nicklas 359       <listitem>
3403 29 May 07 nicklas 360         <para>
3403 29 May 07 nicklas 361           Use the <guibutton>New</guibutton> button on the 
3403 29 May 07 nicklas 362           <menuchoice>
3403 29 May 07 nicklas 363             <guimenu>View</guimenu>
3403 29 May 07 nicklas 364             <guimenuitem>Reporter lists</guimenuitem>
5706 23 Aug 11 nicklas 365           </menuchoice> page. This creates an initially empty reporter list
5706 23 Aug 11 nicklas 366           that can be filled later.
3403 29 May 07 nicklas 367         </para>
3403 29 May 07 nicklas 368       </listitem>
3403 29 May 07 nicklas 369       
5706 23 Aug 11 nicklas 370       <listitem>
5706 23 Aug 11 nicklas 371         <para>
5706 23 Aug 11 nicklas 372           Use the <guibutton>New reporter list</guibutton> button on the 
5706 23 Aug 11 nicklas 373           <guilabel>Features</guilabel> tab on the single-item view page
5706 23 Aug 11 nicklas 374           for an array design. This creates a reporter list with all or some of
5706 23 Aug 11 nicklas 375           the reporters used on the array design.
5706 23 Aug 11 nicklas 376         </para>
5706 23 Aug 11 nicklas 377       </listitem>
5706 23 Aug 11 nicklas 378       
5706 23 Aug 11 nicklas 379       <listitem>
5706 23 Aug 11 nicklas 380         <para>
5706 23 Aug 11 nicklas 381           Use the <guibutton>New reporter list</guibutton> button on the 
5706 23 Aug 11 nicklas 382           <guilabel>Raw data</guilabel> tab on the single-item view page
5706 23 Aug 11 nicklas 383           for a raw bioassay. This creates a reporter list with all or some of
5706 23 Aug 11 nicklas 384           the reporters used by the raw bioassay.
5706 23 Aug 11 nicklas 385         </para>
5706 23 Aug 11 nicklas 386       </listitem>
5706 23 Aug 11 nicklas 387       
5706 23 Aug 11 nicklas 388       <listitem>
5706 23 Aug 11 nicklas 389         <para>
5706 23 Aug 11 nicklas 390           Use the <guibutton>New reporter list</guibutton> button on the 
5706 23 Aug 11 nicklas 391           <guilabel>Spot data</guilabel> tab on the single-item view page
5706 23 Aug 11 nicklas 392           for a bioassay set in the experiment analysis section. 
5706 23 Aug 11 nicklas 393           This creates a reporter list with all or some of
5706 23 Aug 11 nicklas 394           the reporters used by the current bioassay set.
5706 23 Aug 11 nicklas 395         </para>
5706 23 Aug 11 nicklas 396       </listitem>
5706 23 Aug 11 nicklas 397       
5706 23 Aug 11 nicklas 398       <listitem>
5706 23 Aug 11 nicklas 399         <para>
5706 23 Aug 11 nicklas 400           Use the <guibutton>New reporter list</guibutton> button on the 
5706 23 Aug 11 nicklas 401           <guilabel>Reporter search</guilabel> tab in experiment explorer.
5706 23 Aug 11 nicklas 402           This creates a reporter list with all or some of
5706 23 Aug 11 nicklas 403           the reporters used by the current bioassay set.
5706 23 Aug 11 nicklas 404         </para>
5706 23 Aug 11 nicklas 405       </listitem>
5706 23 Aug 11 nicklas 406       
5706 23 Aug 11 nicklas 407       </itemizedlist>
5706 23 Aug 11 nicklas 408       
3403 29 May 07 nicklas 409       <figure
3403 29 May 07 nicklas 410         id="reporterlists.figures.create">
3403 29 May 07 nicklas 411         <title>
3403 29 May 07 nicklas 412           The Create reporter list called from
3403 29 May 07 nicklas 413           the reporters page.
3403 29 May 07 nicklas 414         </title>
3403 29 May 07 nicklas 415         <screenshot>
3403 29 May 07 nicklas 416           <mediaobject>
3403 29 May 07 nicklas 417             <imageobject>
3403 29 May 07 nicklas 418               <imagedata fileref="figures/reporterlist-1.png" format="PNG" />
3403 29 May 07 nicklas 419             </imageobject>
3403 29 May 07 nicklas 420           </mediaobject>
3403 29 May 07 nicklas 421         </screenshot>
3403 29 May 07 nicklas 422       </figure>
3403 29 May 07 nicklas 423     
3403 29 May 07 nicklas 424       <helptext external_id="reporterlist.edit" 
3403 29 May 07 nicklas 425         title="Create reporter list">
3403 29 May 07 nicklas 426         
3403 29 May 07 nicklas 427         <variablelist>
3403 29 May 07 nicklas 428         <varlistentry>
3403 29 May 07 nicklas 429           <term><guilabel>Name</guilabel></term>
3403 29 May 07 nicklas 430           <listitem>
3403 29 May 07 nicklas 431             <para>
3403 29 May 07 nicklas 432             The name of the reporter list.
3403 29 May 07 nicklas 433             </para>
3403 29 May 07 nicklas 434           </listitem>
3403 29 May 07 nicklas 435         </varlistentry>
3403 29 May 07 nicklas 436         <varlistentry>
4403 21 Aug 08 jari 437           <term><guilabel>External ID</guilabel></term>
3403 29 May 07 nicklas 438           <listitem>
3403 29 May 07 nicklas 439             <para>
3403 29 May 07 nicklas 440             An optional external ID. This value is useful,
3403 29 May 07 nicklas 441             for example, for a tool that automatically
4403 21 Aug 08 jari 442             updates the reporter list from some external source.
3403 29 May 07 nicklas 443             It is not used by BASE.
3403 29 May 07 nicklas 444             </para>
3403 29 May 07 nicklas 445           </listitem>
3403 29 May 07 nicklas 446         </varlistentry>
3403 29 May 07 nicklas 447         <varlistentry>
3403 29 May 07 nicklas 448           <term><guilabel>Which reporters</guilabel></term>
3403 29 May 07 nicklas 449           <listitem>
3403 29 May 07 nicklas 450             <para>
3403 29 May 07 nicklas 451             Select one of the options for specifying which reporters
5706 23 Aug 11 nicklas 452             should be included in the list. This option is only available
5706 23 Aug 11 nicklas 453             when creating a new reporter list, not when editing an existing
5795 10 Oct 11 nicklas 454             list. The default is to create a list with <emphasis>all</emphasis>
5795 10 Oct 11 nicklas 455             reporters that are in the current list. 
3403 29 May 07 nicklas 456             </para>
3403 29 May 07 nicklas 457           </listitem>
3403 29 May 07 nicklas 458         </varlistentry>
3403 29 May 07 nicklas 459         <varlistentry>
3403 29 May 07 nicklas 460           <term><guilabel>Description</guilabel></term>
3403 29 May 07 nicklas 461           <listitem>
3403 29 May 07 nicklas 462             <para>
3403 29 May 07 nicklas 463             A description of the reporter list.
3403 29 May 07 nicklas 464             </para>
3403 29 May 07 nicklas 465           </listitem>
3403 29 May 07 nicklas 466         </varlistentry>
3403 29 May 07 nicklas 467         </variablelist>
5706 23 Aug 11 nicklas 468
5706 23 Aug 11 nicklas 469         <tip>
5706 23 Aug 11 nicklas 470           <para>
5706 23 Aug 11 nicklas 471           To add or remove reporters to the list use the
5706 23 Aug 11 nicklas 472           <guilabel>Reporters</guilabel> tab on the single-item
5706 23 Aug 11 nicklas 473           view page of a reporter list. This tab lists all 
5706 23 Aug 11 nicklas 474           reporters in the list and there are functions for
5706 23 Aug 11 nicklas 475           removing, adding and importing reporters to the list.
5706 23 Aug 11 nicklas 476           </para>
5706 23 Aug 11 nicklas 477         </tip>
5706 23 Aug 11 nicklas 478
5706 23 Aug 11 nicklas 479
3403 29 May 07 nicklas 480       </helptext>
3372 24 May 07 philippe 481
5795 10 Oct 11 nicklas 482
5795 10 Oct 11 nicklas 483     <sect2 id="reporterlists.merge">
5795 10 Oct 11 nicklas 484       <title>Merging reporter lists</title>
5795 10 Oct 11 nicklas 485
5795 10 Oct 11 nicklas 486       <para>
5795 10 Oct 11 nicklas 487         It is possible to modify a reporter list by merging it with other reporter
5795 10 Oct 11 nicklas 488         lists. Go to the single-item view page for a reporter list. There should be
5795 10 Oct 11 nicklas 489         three buttons in the toolbar corresponding to three main merge variants:
5795 10 Oct 11 nicklas 490       </para>
5795 10 Oct 11 nicklas 491       
5795 10 Oct 11 nicklas 492       <itemizedlist>
5795 10 Oct 11 nicklas 493         <listitem>
5795 10 Oct 11 nicklas 494           <para>
5795 10 Oct 11 nicklas 495             <guilabel>Union:</guilabel> Add all reporters from 
5795 10 Oct 11 nicklas 496             the source lists to the destination list.
5795 10 Oct 11 nicklas 497           </para>
5795 10 Oct 11 nicklas 498         </listitem>
5795 10 Oct 11 nicklas 499         <listitem>
5795 10 Oct 11 nicklas 500           <para>
5795 10 Oct 11 nicklas 501             <guilabel>Intersection:</guilabel> Keep only reporters
5795 10 Oct 11 nicklas 502             that are present in all selected lists.
5795 10 Oct 11 nicklas 503           </para>
5795 10 Oct 11 nicklas 504         </listitem>
5795 10 Oct 11 nicklas 505         <listitem>
5795 10 Oct 11 nicklas 506           <para>
5795 10 Oct 11 nicklas 507             <guilabel>Complement:</guilabel> Keep only reporters that
5795 10 Oct 11 nicklas 508             are unique for the destination list.
5795 10 Oct 11 nicklas 509           </para>
5795 10 Oct 11 nicklas 510         </listitem>
5795 10 Oct 11 nicklas 511       </itemizedlist>
5795 10 Oct 11 nicklas 512       
5795 10 Oct 11 nicklas 513       <para>
5795 10 Oct 11 nicklas 514         All three buttons open up the same dialog with different default selections.
5795 10 Oct 11 nicklas 515       </para>
5795 10 Oct 11 nicklas 516
5795 10 Oct 11 nicklas 517       <figure
5795 10 Oct 11 nicklas 518         id="reporterlists.figures.merge">
5795 10 Oct 11 nicklas 519         <title>Merge reporter lists</title>
5795 10 Oct 11 nicklas 520         <screenshot>
5795 10 Oct 11 nicklas 521           <mediaobject>
5795 10 Oct 11 nicklas 522             <imageobject>
5795 10 Oct 11 nicklas 523               <imagedata fileref="figures/reporterlist-merge.png" format="PNG" />
5795 10 Oct 11 nicklas 524             </imageobject>
5795 10 Oct 11 nicklas 525           </mediaobject>
5795 10 Oct 11 nicklas 526         </screenshot>
5795 10 Oct 11 nicklas 527       </figure>
5795 10 Oct 11 nicklas 528
5795 10 Oct 11 nicklas 529       <helptext external_id="reporterlist.merge" 
5795 10 Oct 11 nicklas 530         title="Merge reporter lists">
5795 10 Oct 11 nicklas 531       
5795 10 Oct 11 nicklas 532         
5795 10 Oct 11 nicklas 533         <variablelist>
5795 10 Oct 11 nicklas 534           <varlistentry>
5795 10 Oct 11 nicklas 535             <term><guilabel>This list</guilabel></term>
5795 10 Oct 11 nicklas 536             <listitem>
5795 10 Oct 11 nicklas 537               <para>Shows the name of the current reporter list.</para>
5795 10 Oct 11 nicklas 538             </listitem>
5795 10 Oct 11 nicklas 539           </varlistentry>
5795 10 Oct 11 nicklas 540           <varlistentry>
5795 10 Oct 11 nicklas 541             <term><guilabel>What to do</guilabel></term>
5795 10 Oct 11 nicklas 542             <listitem>
5795 10 Oct 11 nicklas 543               <para>
5795 10 Oct 11 nicklas 544                 In this drop-down list you can select if you want to
5795 10 Oct 11 nicklas 545                 <emphasis>add</emphasis>, <emphasis>keep</emphasis>
5795 10 Oct 11 nicklas 546                 or <emphasis>remove</emphasis> reporters from the
5795 10 Oct 11 nicklas 547                 selected list based on if a reporter is present in one
5795 10 Oct 11 nicklas 548                 or all of some other reporter lists (selected below). 
5795 10 Oct 11 nicklas 549                 The image to the right gives an overview what will 
5795 10 Oct 11 nicklas 550                 happen for the currently selected alternatives. The
5795 10 Oct 11 nicklas 551                 red-colored areas indicate which reporters that are
5795 10 Oct 11 nicklas 552                 included in the final list. The white-colored areas 
5795 10 Oct 11 nicklas 553                 indicate reporters that doesn't pass the filter and
5795 10 Oct 11 nicklas 554                 are excluded from the final list.
5795 10 Oct 11 nicklas 555               </para>
5795 10 Oct 11 nicklas 556             </listitem>
5795 10 Oct 11 nicklas 557           </varlistentry>
5795 10 Oct 11 nicklas 558           <varlistentry>
5795 10 Oct 11 nicklas 559             <term><guilabel>Reporter lists</guilabel></term>
5795 10 Oct 11 nicklas 560             <listitem>
5795 10 Oct 11 nicklas 561               <para>
5795 10 Oct 11 nicklas 562                 You will need to select at least one more list
5795 10 Oct 11 nicklas 563                 to merge with.
5795 10 Oct 11 nicklas 564               </para>
5795 10 Oct 11 nicklas 565             </listitem>
5795 10 Oct 11 nicklas 566           </varlistentry>
5795 10 Oct 11 nicklas 567         
5795 10 Oct 11 nicklas 568         </variablelist>
5795 10 Oct 11 nicklas 569       
5795 10 Oct 11 nicklas 570
5795 10 Oct 11 nicklas 571       </helptext>
5795 10 Oct 11 nicklas 572     </sect2>
5795 10 Oct 11 nicklas 573
5795 10 Oct 11 nicklas 574
5795 10 Oct 11 nicklas 575
3403 29 May 07 nicklas 576   </sect1>
3372 24 May 07 philippe 577 </chapter>

Generated on Sat Oct  7 02:27:35 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)