doc/src/docbook/user/derivedbioassays.xml

Code
Comments
Other
Rev Date Author Line
3487 13 Jun 07 peter 1 <?xml version="1.0" encoding="UTF-8"?>
3487 13 Jun 07 peter 2 <!DOCTYPE sect1 PUBLIC 
3487 13 Jun 07 peter 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3487 13 Jun 07 peter 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3487 13 Jun 07 peter 5 <!--
3487 13 Jun 07 peter 6   $Id$
3487 13 Jun 07 peter 7
3675 16 Aug 07 jari 8   Copyright (C) 2007 Peter Johansson, Nicklas Nordborg
3487 13 Jun 07 peter 9
3487 13 Jun 07 peter 10   This file is part of BASE - BioArray Software Environment.
3487 13 Jun 07 peter 11   Available at http://base.thep.lu.se/
3487 13 Jun 07 peter 12
3487 13 Jun 07 peter 13   BASE is free software; you can redistribute it and/or
3487 13 Jun 07 peter 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3487 13 Jun 07 peter 16   of the License, or (at your option) any later version.
3487 13 Jun 07 peter 17
3487 13 Jun 07 peter 18   BASE is distributed in the hope that it will be useful,
3487 13 Jun 07 peter 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3487 13 Jun 07 peter 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3487 13 Jun 07 peter 21   GNU General Public License for more details.
3487 13 Jun 07 peter 22
3487 13 Jun 07 peter 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3318 10 May 07 nicklas 25 -->
5783 05 Oct 11 nicklas 26 <sect1 id="experiments_analysis.derivedbioassays">
5783 05 Oct 11 nicklas 27   <?dbhtml filename="derivedbioassays.html" ?>
5783 05 Oct 11 nicklas 28   
5783 05 Oct 11 nicklas 29   <title>Derived bioassays</title>
3318 10 May 07 nicklas 30   <para>
5783 05 Oct 11 nicklas 31     When you have processed your physical bioassay you can 
5783 05 Oct 11 nicklas 32     register any information that you have gathered as
5783 05 Oct 11 nicklas 33     <guilabel>Derived bioassay</guilabel> items in BASE.
5783 05 Oct 11 nicklas 34     The derived bioassay can represent both a physical process,
5783 05 Oct 11 nicklas 35     such as scanning a microarray slide, or a software
5783 05 Oct 11 nicklas 36     process such as aligning sequence data against a reference
5783 05 Oct 11 nicklas 37     genome. It is even possible to register child derived
5783 05 Oct 11 nicklas 38     bioassays if there are multiple steps involved that you want
5783 05 Oct 11 nicklas 39     to register independently. Each derived bioassay can
5800 12 Oct 11 nicklas 40     specify a protocol (with parameters if needed) and the hardware
5783 05 Oct 11 nicklas 41     or software item that was used to create it. 
3318 10 May 07 nicklas 42   </para>
3318 10 May 07 nicklas 43   
5783 05 Oct 11 nicklas 44   <para>
5783 05 Oct 11 nicklas 45     It is also possible to link one or more files to the derived
5783 05 Oct 11 nicklas 46     bioassay. This feature requires that a subtype is selected and
5783 05 Oct 11 nicklas 47     that the subtype has been linked with the file types that 
5783 05 Oct 11 nicklas 48     are useful in that context. For example, the <guilabel>Scan</guilabel>
5783 05 Oct 11 nicklas 49     subtype is linked with <guilabel>Image</guilabel> files.
5800 12 Oct 11 nicklas 50     See <xref linkend="subtypes" /> for more information.
5783 05 Oct 11 nicklas 51   </para>
5783 05 Oct 11 nicklas 52   
3318 10 May 07 nicklas 53   <note>
5783 05 Oct 11 nicklas 54     <para>
5783 05 Oct 11 nicklas 55     A derived bioassay can only hold data in the form of files.
5783 05 Oct 11 nicklas 56     When the data has been processed enough to make it a sensible
5783 05 Oct 11 nicklas 57     option (performance-wise) to import into the database a 
5783 05 Oct 11 nicklas 58     <guilabel>Raw bioassay</guilabel> should be created.
5783 05 Oct 11 nicklas 59     </para>
3318 10 May 07 nicklas 60   </note>
3318 10 May 07 nicklas 61   
5783 05 Oct 11 nicklas 62   <sect2 id="experiments_analysis.derivedbioassays.create">
5783 05 Oct 11 nicklas 63     <title>Create derived bioassays</title>
5783 05 Oct 11 nicklas 64   
5783 05 Oct 11 nicklas 65     <para>
5783 05 Oct 11 nicklas 66       Beside the common way, using the &gbNew; button, a derived bioassay can be created in one of
5783 05 Oct 11 nicklas 67       the following ways:
5783 05 Oct 11 nicklas 68     </para>
5783 05 Oct 11 nicklas 69       <variablelist>
5783 05 Oct 11 nicklas 70         <varlistentry>
5783 05 Oct 11 nicklas 71           <term>from either physical bioassay list- or single view- page.</term>
5783 05 Oct 11 nicklas 72           <listitem>
5783 05 Oct 11 nicklas 73             <para>
6102 04 Sep 12 nicklas 74               A root derived bioassay is a bioassay that has one or more physical
6102 04 Sep 12 nicklas 75               bioassays as parents. Therefore, a natural way to create a derived bioassay 
6102 04 Sep 12 nicklas 76               is to click on
5783 05 Oct 11 nicklas 77               <guiicon>
5783 05 Oct 11 nicklas 78                 <inlinemediaobject>
5783 05 Oct 11 nicklas 79                   <imageobject>
5783 05 Oct 11 nicklas 80                     <imagedata fileref="figures/add.png" format="PNG" />
5783 05 Oct 11 nicklas 81                   </imageobject>
5783 05 Oct 11 nicklas 82                 </inlinemediaobject>
5783 05 Oct 11 nicklas 83               </guiicon>
5783 05 Oct 11 nicklas 84               in the <guilabel>Derived bioassays</guilabel> column in the list view. There is also a
5783 05 Oct 11 nicklas 85               corresponding button, <guibutton>New derived bioassay&hellip;</guibutton>
6102 04 Sep 12 nicklas 86               in the toolbar both in the list and single-item view.
5783 05 Oct 11 nicklas 87             </para>
5783 05 Oct 11 nicklas 88           </listitem>
5783 05 Oct 11 nicklas 89         </varlistentry>
5783 05 Oct 11 nicklas 90         <varlistentry>
5783 05 Oct 11 nicklas 91           <term>from either derived bioassays list- or single view- page</term>
5783 05 Oct 11 nicklas 92           <listitem>
5783 05 Oct 11 nicklas 93             <para>
6102 04 Sep 12 nicklas 94               A child derived bioassay is a bioassay that has one or more 
6102 04 Sep 12 nicklas 95               derived bioassays as parents. Click on the 
5783 05 Oct 11 nicklas 96               <guiicon>
5783 05 Oct 11 nicklas 97                 <inlinemediaobject>
5783 05 Oct 11 nicklas 98                   <imageobject>
5783 05 Oct 11 nicklas 99                     <imagedata fileref="figures/add.png" format="PNG" />
5783 05 Oct 11 nicklas 100                   </imageobject>
5783 05 Oct 11 nicklas 101                 </inlinemediaobject>
5783 05 Oct 11 nicklas 102               </guiicon> icon in the <guilabel>Child bioassays</guilabel> column
6102 04 Sep 12 nicklas 103               to create a new child derived bioassay. There is also a <guibutton>Merge</guibutton>
6102 04 Sep 12 nicklas 104               button in the list view and a <guibutton>New child bioassay</guibutton>
6102 04 Sep 12 nicklas 105               button in the single-item view.
5783 05 Oct 11 nicklas 106             </para>
5783 05 Oct 11 nicklas 107           </listitem>
5783 05 Oct 11 nicklas 108         </varlistentry>
5783 05 Oct 11 nicklas 109       </variablelist>
5783 05 Oct 11 nicklas 110   </sect2>
5783 05 Oct 11 nicklas 111   
5783 05 Oct 11 nicklas 112   <sect2 id="experiment_analysis.derivedbioassay.properties">
5783 05 Oct 11 nicklas 113     <title>Derived bioassay properties</title>
3318 10 May 07 nicklas 114     
5800 12 Oct 11 nicklas 115       <figure id="experiment_analysis.figures.derivedbioassay">
5800 12 Oct 11 nicklas 116         <title>Derived bioassay properties</title>
5800 12 Oct 11 nicklas 117         <screenshot>
5800 12 Oct 11 nicklas 118           <mediaobject>
5800 12 Oct 11 nicklas 119             <imageobject>
5800 12 Oct 11 nicklas 120               <imagedata 
5800 12 Oct 11 nicklas 121                 fileref="figures/derivedbioassay_edit.png" format="PNG" />
5800 12 Oct 11 nicklas 122             </imageobject>
5800 12 Oct 11 nicklas 123           </mediaobject>
5800 12 Oct 11 nicklas 124         </screenshot>
5800 12 Oct 11 nicklas 125       </figure>
3318 10 May 07 nicklas 126     
5783 05 Oct 11 nicklas 127     <helptext external_id="derivedbioassay.edit" title="Edit derived bioassay">
3318 10 May 07 nicklas 128     <variablelist>
3318 10 May 07 nicklas 129       <varlistentry>
3318 10 May 07 nicklas 130         <term><guilabel>Name</guilabel></term>
3318 10 May 07 nicklas 131         <listitem>
3318 10 May 07 nicklas 132           <para>
5783 05 Oct 11 nicklas 133             The name of the derived bioassay.
3318 10 May 07 nicklas 134           </para>
3318 10 May 07 nicklas 135         </listitem>
3318 10 May 07 nicklas 136       </varlistentry>
3318 10 May 07 nicklas 137       <varlistentry>
5783 05 Oct 11 nicklas 138         <term><guilabel>Type</guilabel></term>
3318 10 May 07 nicklas 139         <listitem>
3318 10 May 07 nicklas 140           <para>
5783 05 Oct 11 nicklas 141             The subtype of the derived bioassay. The list may evolve depending on additions by 
5783 05 Oct 11 nicklas 142             the server administrator. Selecting the proper subtype is required
5783 05 Oct 11 nicklas 143             to be able to attach data files to the bioassay. It will also help BASE
5783 05 Oct 11 nicklas 144             to automatically guess the most likely subtype when creating child bioassays. 
5783 05 Oct 11 nicklas 145             <nohelp>
5783 05 Oct 11 nicklas 146             See <xref linkend="subtypes" /> for more information.
5783 05 Oct 11 nicklas 147             </nohelp>
3318 10 May 07 nicklas 148           </para>
3318 10 May 07 nicklas 149         </listitem>
3318 10 May 07 nicklas 150       </varlistentry>
3318 10 May 07 nicklas 151       <varlistentry>
5783 05 Oct 11 nicklas 152         <term><guilabel>Parent type</guilabel></term>
3318 10 May 07 nicklas 153         <listitem>
3318 10 May 07 nicklas 154           <para>
6102 04 Sep 12 nicklas 155             Select if the parent items should be physical or derived bioassays.
6102 04 Sep 12 nicklas 156             This option is only available when creating new derived bioassays. 
6102 04 Sep 12 nicklas 157             Once created it is not possible to change the parent type.
3318 10 May 07 nicklas 158           </para>
3318 10 May 07 nicklas 159         </listitem>
3318 10 May 07 nicklas 160       </varlistentry>
3318 10 May 07 nicklas 161       <varlistentry>
6102 04 Sep 12 nicklas 162         <term><guilabel>Physical bioassays/parents</guilabel></term>
6102 04 Sep 12 nicklas 163         <listitem>
6102 04 Sep 12 nicklas 164           <para>
6102 04 Sep 12 nicklas 165             Use the <guibutton>Add bioassays</guibutton> and <guibutton>Remove</guibutton> buttons
6102 04 Sep 12 nicklas 166             to add or remove parent items.
6102 04 Sep 12 nicklas 167           </para>
6102 04 Sep 12 nicklas 168         </listitem>
6102 04 Sep 12 nicklas 169       </varlistentry>
6102 04 Sep 12 nicklas 170       <varlistentry>
5783 05 Oct 11 nicklas 171         <term><guilabel>Extract</guilabel></term>
3318 10 May 07 nicklas 172         <listitem>
3318 10 May 07 nicklas 173           <para>
6102 04 Sep 12 nicklas 174             Select the extract that this derived bioassay is linked with. The <guibutton>Select</guibutton>
6102 04 Sep 12 nicklas 175             button opens a selection list that is pre-filtered with all extracts that are
6102 04 Sep 12 nicklas 176             found on the parent physical bioassays including all parent extracts.
5783 05 Oct 11 nicklas 177             Do not select an extract if the derived bioassay represents more than
5783 05 Oct 11 nicklas 178             one extract at this stage.
3318 10 May 07 nicklas 179           </para>
3318 10 May 07 nicklas 180         </listitem>
3318 10 May 07 nicklas 181       </varlistentry>
3318 10 May 07 nicklas 182       <varlistentry>
5783 05 Oct 11 nicklas 183         <term><guilabel>Protocol</guilabel></term>
3318 10 May 07 nicklas 184         <listitem>
3318 10 May 07 nicklas 185           <para>
5783 05 Oct 11 nicklas 186             The protocol used in the process that created this derived bioassay (optional). 
5783 05 Oct 11 nicklas 187             Parameters may be registered as part of the protocol.
3318 10 May 07 nicklas 188           </para>
3318 10 May 07 nicklas 189         </listitem>
3318 10 May 07 nicklas 190       </varlistentry>
3318 10 May 07 nicklas 191       <varlistentry>
5783 05 Oct 11 nicklas 192         <term><guilabel>Hardware</guilabel></term>
3318 10 May 07 nicklas 193         <listitem>
3318 10 May 07 nicklas 194           <para>
5783 05 Oct 11 nicklas 195             The machine used in the process that created this derived bioassay (optional). 
3318 10 May 07 nicklas 196           </para>
3318 10 May 07 nicklas 197         </listitem>
3318 10 May 07 nicklas 198       </varlistentry>
3318 10 May 07 nicklas 199       <varlistentry>
5783 05 Oct 11 nicklas 200         <term><guilabel>Software</guilabel></term>
3318 10 May 07 nicklas 201         <listitem>
3318 10 May 07 nicklas 202           <para>
5783 05 Oct 11 nicklas 203             The software used in the process that created this derived bioassay (optional). 
3318 10 May 07 nicklas 204           </para>
3318 10 May 07 nicklas 205         </listitem>
3318 10 May 07 nicklas 206       </varlistentry>
3318 10 May 07 nicklas 207       <varlistentry>
3318 10 May 07 nicklas 208         <term><guilabel>Description</guilabel></term>
3318 10 May 07 nicklas 209         <listitem>
3318 10 May 07 nicklas 210           <para>
5783 05 Oct 11 nicklas 211             A decription of the derived bioassay (optional).
3318 10 May 07 nicklas 212           </para>
3318 10 May 07 nicklas 213         </listitem>
3318 10 May 07 nicklas 214       </varlistentry>
3318 10 May 07 nicklas 215     </variablelist>
3318 10 May 07 nicklas 216     
5783 05 Oct 11 nicklas 217     <seeother>
5783 05 Oct 11 nicklas 218       <other external_id="datafiles.edit">Data files</other>
5783 05 Oct 11 nicklas 219       <other external_id="annotations.edit">Annotations</other>
5783 05 Oct 11 nicklas 220       <other external_id="annotations.edit.inerited">Inherit annotations</other>
5783 05 Oct 11 nicklas 221     </seeother>
5783 05 Oct 11 nicklas 222     
5783 05 Oct 11 nicklas 223     </helptext>
5800 12 Oct 11 nicklas 224   
5800 12 Oct 11 nicklas 225     <para>
5800 12 Oct 11 nicklas 226       The <guilabel>Data files</guilabel> tab allows BASE users to select
5800 12 Oct 11 nicklas 227       files that contains data for the derived bioassay. 
5800 12 Oct 11 nicklas 228       Read more about this in <xref linkend="platforms.selectfiles" />.
5800 12 Oct 11 nicklas 229     </para>
5800 12 Oct 11 nicklas 230   
5800 12 Oct 11 nicklas 231     <para>
5800 12 Oct 11 nicklas 232       The <guilabel>Annotations</guilabel> tab allows BASE users to use 
5800 12 Oct 11 nicklas 233       annotation types to refine bioassay description. More about annotating items 
5800 12 Oct 11 nicklas 234       can be read in <xref linkend="annotations.annotating" />
5800 12 Oct 11 nicklas 235     </para>
5800 12 Oct 11 nicklas 236         
5800 12 Oct 11 nicklas 237     <para>
5800 12 Oct 11 nicklas 238       This <guilabel>Inherited annotations</guilabel> tab contains a list of those annotations
5800 12 Oct 11 nicklas 239       that are inherited from the bioassay's parents. Information about working with inherited 
5800 12 Oct 11 nicklas 240       annotations can be found in <xref linkend="annotations.inheriting" />.
5800 12 Oct 11 nicklas 241     </para>
5800 12 Oct 11 nicklas 242   
3318 10 May 07 nicklas 243   </sect2>
5783 05 Oct 11 nicklas 244
3487 13 Jun 07 peter 245   
3487 13 Jun 07 peter 246 </sect1>