doc/src/docbook/user/subtypes.xml

Code
Comments
Other
Rev Date Author Line
5706 23 Aug 11 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
5706 23 Aug 11 nicklas 2 <!DOCTYPE chapter PUBLIC 
5706 23 Aug 11 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
5706 23 Aug 11 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5706 23 Aug 11 nicklas 5 <!--
5706 23 Aug 11 nicklas 6   $Id $
5706 23 Aug 11 nicklas 7   
5706 23 Aug 11 nicklas 8   Copyright (C) 2011 Nicklas Nordborg
5706 23 Aug 11 nicklas 9   
5706 23 Aug 11 nicklas 10   This file is part of BASE - BioArray Software Environment.
5706 23 Aug 11 nicklas 11   Available at http://base.thep.lu.se/
5706 23 Aug 11 nicklas 12   
5706 23 Aug 11 nicklas 13   BASE is free software; you can redistribute it and/or
5706 23 Aug 11 nicklas 14   modify it under the terms of the GNU General Public License
5706 23 Aug 11 nicklas 15   as published by the Free Software Foundation; either version 3
5706 23 Aug 11 nicklas 16   of the License, or (at your option) any later version.
5706 23 Aug 11 nicklas 17   
5706 23 Aug 11 nicklas 18   BASE is distributed in the hope that it will be useful,
5706 23 Aug 11 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
5706 23 Aug 11 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5706 23 Aug 11 nicklas 21   GNU General Public License for more details.
5706 23 Aug 11 nicklas 22   
5706 23 Aug 11 nicklas 23   You should have received a copy of the GNU General Public License
5706 23 Aug 11 nicklas 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
5706 23 Aug 11 nicklas 25 -->
5706 23 Aug 11 nicklas 26
5706 23 Aug 11 nicklas 27 <chapter id="subtypes" chunked="0">
5706 23 Aug 11 nicklas 28   <title>Item subtypes</title>
5706 23 Aug 11 nicklas 29
5706 23 Aug 11 nicklas 30   <para>
5706 23 Aug 11 nicklas 31     Several of the main item types in BASE can be subclassified by subtypes. This includes for example,
5706 23 Aug 11 nicklas 32     <emphasis>biosources</emphasis>, <emphasis>samples</emphasis> and <emphasis>extracts</emphasis>
5706 23 Aug 11 nicklas 33     as well as <emphasis>protocols</emphasis>, <emphasis>hardware</emphasis> and 
5706 23 Aug 11 nicklas 34     <emphasis>software</emphasis>.
5706 23 Aug 11 nicklas 35     One of the main reasons for subtypes is to group items together and allowing users to filter
5706 23 Aug 11 nicklas 36     out items that are or no interest in the current context. For example, the protocol selection
5706 23 Aug 11 nicklas 37     list when creating an extract is filtered to only show <emphasis>Extraction</emphasis> protocols.
5706 23 Aug 11 nicklas 38   </para>
5706 23 Aug 11 nicklas 39   
5706 23 Aug 11 nicklas 40   <para>
5706 23 Aug 11 nicklas 41     The filtering can be even more fine-grained by linking subtypes to each other. For example, in
5706 23 Aug 11 nicklas 42     a standard BASE installation there are two extract subtypes: <emphasis>Labeled extract</emphasis>
5706 23 Aug 11 nicklas 43     and <emphasis>Library</emphasis>. The labeled extract subtype is linked with the 
5706 23 Aug 11 nicklas 44     <emphasis>Labeling</emphasis> protocol subtype and the library subtype is linked with the
5706 23 Aug 11 nicklas 45     <emphasis>Library preparation</emphasis> protocol subtype. So by assigning the correct
5706 23 Aug 11 nicklas 46     subtype to a protocol, BASE knows which one that should be used when creating a labeled
5706 23 Aug 11 nicklas 47     extract and which one should be used when creating a library. 
5706 23 Aug 11 nicklas 48   </para>
5706 23 Aug 11 nicklas 49   
5706 23 Aug 11 nicklas 50   <tip>
5706 23 Aug 11 nicklas 51     <title>Project default items</title>
5706 23 Aug 11 nicklas 52     <para>
5706 23 Aug 11 nicklas 53       This feature can be a real time-saver when used together with project default items
5706 23 Aug 11 nicklas 54       (see <xref linkend="project_permissions.project.defaults" />).
5795 10 Oct 11 nicklas 55       When creating new items (eg. a biomaterial) BASE will search among the 
5706 23 Aug 11 nicklas 56       default items in the active project for protocols, hardware, software, 
5706 23 Aug 11 nicklas 57       etc. and automatically select the best match based on the subtype of the new 
5706 23 Aug 11 nicklas 58       item.
5706 23 Aug 11 nicklas 59     </para>
5706 23 Aug 11 nicklas 60   </tip>
5706 23 Aug 11 nicklas 61   
5706 23 Aug 11 nicklas 62   <para>
5706 23 Aug 11 nicklas 63     Subtypes are typically added to a BASE server by an administrator
5706 23 Aug 11 nicklas 64     and can be managed from <menuchoice>
5706 23 Aug 11 nicklas 65         <guimenu>Administrate</guimenu>
5706 23 Aug 11 nicklas 66         <guisubmenu>Types</guisubmenu>
5706 23 Aug 11 nicklas 67         <guimenuitem>Item subtypes</guimenuitem>
5706 23 Aug 11 nicklas 68       </menuchoice>.
5706 23 Aug 11 nicklas 69   </para>
5706 23 Aug 11 nicklas 70   
5706 23 Aug 11 nicklas 71   <sect1 id="subtypes.properties">
5706 23 Aug 11 nicklas 72     <title>Item subtype properties</title>
5706 23 Aug 11 nicklas 73     
5706 23 Aug 11 nicklas 74     <figure
5706 23 Aug 11 nicklas 75       id="subtypes.figures.edit_subtype">
5706 23 Aug 11 nicklas 76       <title>Item subtype properties</title>
5706 23 Aug 11 nicklas 77       <screenshot>
5706 23 Aug 11 nicklas 78         <mediaobject>
5706 23 Aug 11 nicklas 79           <imageobject>
5706 23 Aug 11 nicklas 80             <imagedata
5706 23 Aug 11 nicklas 81               fileref="figures/edit_subtype.png" format="PNG" />
5706 23 Aug 11 nicklas 82           </imageobject>
5706 23 Aug 11 nicklas 83         </mediaobject>
5706 23 Aug 11 nicklas 84       </screenshot>
5706 23 Aug 11 nicklas 85     </figure>
5706 23 Aug 11 nicklas 86     
5706 23 Aug 11 nicklas 87     <helptext external_id="itemsubtype.edit" 
5706 23 Aug 11 nicklas 88       title="Edit item subtype">
5706 23 Aug 11 nicklas 89     
5706 23 Aug 11 nicklas 90       <variablelist>
5706 23 Aug 11 nicklas 91       <varlistentry>
5706 23 Aug 11 nicklas 92         <term><guilabel>Name</guilabel></term>
5706 23 Aug 11 nicklas 93         <listitem>
5706 23 Aug 11 nicklas 94           <para>
5706 23 Aug 11 nicklas 95           The name of the subtype.
5706 23 Aug 11 nicklas 96           </para>
5706 23 Aug 11 nicklas 97         </listitem>
5706 23 Aug 11 nicklas 98       </varlistentry>
5706 23 Aug 11 nicklas 99     
5706 23 Aug 11 nicklas 100       <varlistentry>
5706 23 Aug 11 nicklas 101         <term><guilabel>Main item type</guilabel></term>
5706 23 Aug 11 nicklas 102         <listitem>
5706 23 Aug 11 nicklas 103           <para>
5706 23 Aug 11 nicklas 104           Select the main item type that the subtype can used on. This can't be changed later.
5706 23 Aug 11 nicklas 105           </para>
5706 23 Aug 11 nicklas 106         </listitem>
5706 23 Aug 11 nicklas 107       </varlistentry>
5706 23 Aug 11 nicklas 108   
5706 23 Aug 11 nicklas 109       <varlistentry>
5706 23 Aug 11 nicklas 110         <term><guilabel>Description</guilabel></term>
5706 23 Aug 11 nicklas 111         <listitem>
5706 23 Aug 11 nicklas 112           <para>
5706 23 Aug 11 nicklas 113           A optional description of the subtype.
5706 23 Aug 11 nicklas 114           </para>
5706 23 Aug 11 nicklas 115         </listitem>
5706 23 Aug 11 nicklas 116       </varlistentry>
5706 23 Aug 11 nicklas 117   
5706 23 Aug 11 nicklas 118       <varlistentry>
5706 23 Aug 11 nicklas 119         <term><guilabel>Related subtypes</guilabel></term>
5706 23 Aug 11 nicklas 120         <listitem>
5706 23 Aug 11 nicklas 121           <para>
5706 23 Aug 11 nicklas 122           This section allows you to select other subtyps that are related to
5706 23 Aug 11 nicklas 123           the current subtype. The possible options depend on the which the
5706 23 Aug 11 nicklas 124           main item type is. For example, for <emphasis>biosource</emphasis>
5795 10 Oct 11 nicklas 125           there are no other related subtypes, but a <emphasis>derived bioassay</emphasis>
5795 10 Oct 11 nicklas 126           can have a related physical bioassay and extract as well as protocol, hardware and
5795 10 Oct 11 nicklas 127           software subtypes.
5706 23 Aug 11 nicklas 128           </para>
5706 23 Aug 11 nicklas 129         </listitem>
5706 23 Aug 11 nicklas 130       </varlistentry>
5706 23 Aug 11 nicklas 131       </variablelist>
5706 23 Aug 11 nicklas 132   
5706 23 Aug 11 nicklas 133       <seeother>
5706 23 Aug 11 nicklas 134         <other external_id="itemsubtype.filetypes">File types</other>
5706 23 Aug 11 nicklas 135       </seeother>
5706 23 Aug 11 nicklas 136     </helptext>
5706 23 Aug 11 nicklas 137     
5706 23 Aug 11 nicklas 138   </sect1>
5706 23 Aug 11 nicklas 139   
5706 23 Aug 11 nicklas 140   <sect1 id="subtypes.filetypes">
5706 23 Aug 11 nicklas 141     <title>File types</title>
5706 23 Aug 11 nicklas 142     
5706 23 Aug 11 nicklas 143     <figure
5706 23 Aug 11 nicklas 144       id="subtypes.figures.filetypes">
5706 23 Aug 11 nicklas 145       <title>Item subtype file types</title>
5706 23 Aug 11 nicklas 146       <screenshot>
5706 23 Aug 11 nicklas 147         <mediaobject>
5706 23 Aug 11 nicklas 148           <imageobject>
5706 23 Aug 11 nicklas 149             <imagedata
5706 23 Aug 11 nicklas 150               fileref="figures/edit_subtype_filetypes.png" format="PNG" />
5706 23 Aug 11 nicklas 151           </imageobject>
5706 23 Aug 11 nicklas 152         </mediaobject>
5706 23 Aug 11 nicklas 153       </screenshot>
5706 23 Aug 11 nicklas 154     </figure>
5706 23 Aug 11 nicklas 155     
5706 23 Aug 11 nicklas 156     
5706 23 Aug 11 nicklas 157     <helptext external_id="itemsubtype.filetypes" title="File types">
5706 23 Aug 11 nicklas 158       <para>
5795 10 Oct 11 nicklas 159         If the main item type for a subtype is a <emphasis>derived bioassay</emphasis> 
5795 10 Oct 11 nicklas 160         (which has support for linking of data files) it is possible to select data file types 
5706 23 Aug 11 nicklas 161         <nohelp>(see <xref linkend="platforms.datafiletypes"/>)</nohelp>
5706 23 Aug 11 nicklas 162         that can be used for items of the given subtype. This is very similar to how
5706 23 Aug 11 nicklas 163         the selected platform of a raw bioassay or array design dictates which
5706 23 Aug 11 nicklas 164         files types that can be used.
5706 23 Aug 11 nicklas 165       </para>
5706 23 Aug 11 nicklas 166       
5706 23 Aug 11 nicklas 167       <variablelist>
5706 23 Aug 11 nicklas 168       <varlistentry>
5706 23 Aug 11 nicklas 169         <term><guilabel>File types</guilabel></term>
5706 23 Aug 11 nicklas 170         <listitem>
5706 23 Aug 11 nicklas 171           <para>
5706 23 Aug 11 nicklas 172           The list contains the file types that are currently associated with the
5706 23 Aug 11 nicklas 173           item subtype.
5706 23 Aug 11 nicklas 174           </para>
5706 23 Aug 11 nicklas 175         </listitem>
5706 23 Aug 11 nicklas 176       </varlistentry>
5795 10 Oct 11 nicklas 177       <varlistentry>
5795 10 Oct 11 nicklas 178         <term><guilabel>Required</guilabel></term>
5795 10 Oct 11 nicklas 179         <listitem>
5795 10 Oct 11 nicklas 180           <para>
5795 10 Oct 11 nicklas 181             Mark this checkbox to indicate that the file is required for
5795 10 Oct 11 nicklas 182             all items of the given subtype.
5795 10 Oct 11 nicklas 183           </para>
5795 10 Oct 11 nicklas 184           
5795 10 Oct 11 nicklas 185           <note>
5795 10 Oct 11 nicklas 186             <para>
5795 10 Oct 11 nicklas 187             The requried flag is not enforced when creating items. It is 
5795 10 Oct 11 nicklas 188             used for generating warnings when validating an experiment and
5795 10 Oct 11 nicklas 189             can be checked by plug-ins that may need the file in order
5795 10 Oct 11 nicklas 190             to run.
5795 10 Oct 11 nicklas 191             </para>
5795 10 Oct 11 nicklas 192           </note>
5795 10 Oct 11 nicklas 193           
5795 10 Oct 11 nicklas 194         </listitem>
5795 10 Oct 11 nicklas 195       </varlistentry>
5795 10 Oct 11 nicklas 196       <varlistentry>
5795 10 Oct 11 nicklas 197         <term><guilabel>Allow multiple files</guilabel></term>
5795 10 Oct 11 nicklas 198         <listitem>
5795 10 Oct 11 nicklas 199           <para>
5795 10 Oct 11 nicklas 200             Mark this checkbox if it is possible to have more than one
5795 10 Oct 11 nicklas 201             file of the given type. In most cases, a single file is used,
5795 10 Oct 11 nicklas 202             but some subtypes, for example Scan, may generate multiple images.
5795 10 Oct 11 nicklas 203           </para>
5795 10 Oct 11 nicklas 204         </listitem>
5795 10 Oct 11 nicklas 205       </varlistentry>
5706 23 Aug 11 nicklas 206       
5706 23 Aug 11 nicklas 207       <varlistentry>
5706 23 Aug 11 nicklas 208         <term><guilabel>Add file types</guilabel></term>
5706 23 Aug 11 nicklas 209         <listitem>
5706 23 Aug 11 nicklas 210           <para>
5706 23 Aug 11 nicklas 211           Click on this button to open a popup window for selecting more file types
5706 23 Aug 11 nicklas 212           to associated with the item subtype.
5706 23 Aug 11 nicklas 213           </para>
5706 23 Aug 11 nicklas 214         </listitem>
5706 23 Aug 11 nicklas 215       </varlistentry>
5706 23 Aug 11 nicklas 216       
5706 23 Aug 11 nicklas 217       <varlistentry>
5706 23 Aug 11 nicklas 218         <term><guilabel>Remove</guilabel></term>
5706 23 Aug 11 nicklas 219         <listitem>
5706 23 Aug 11 nicklas 220           <para>
5706 23 Aug 11 nicklas 221           Click on this button to remove the association with the selected
5706 23 Aug 11 nicklas 222           file types.
5706 23 Aug 11 nicklas 223           </para>
5706 23 Aug 11 nicklas 224         </listitem>
5706 23 Aug 11 nicklas 225       </varlistentry>
5706 23 Aug 11 nicklas 226       
5706 23 Aug 11 nicklas 227       </variablelist>
5706 23 Aug 11 nicklas 228       
5706 23 Aug 11 nicklas 229       <seeother>
5706 23 Aug 11 nicklas 230         <other external_id="itemsubtype.edit">Properties</other>
5706 23 Aug 11 nicklas 231       </seeother>
5706 23 Aug 11 nicklas 232     </helptext>
5706 23 Aug 11 nicklas 233     
5706 23 Aug 11 nicklas 234   
5706 23 Aug 11 nicklas 235   </sect1>  
5706 23 Aug 11 nicklas 236   
5706 23 Aug 11 nicklas 237 </chapter>

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