source: trunk/doc/src/docbook/userdoc/biomaterials.xml @ 3394

Last change on this file since 3394 was 3394, checked in by Martin Svensson, 15 years ago

Replaced the most common guibutton:s with entities

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 65.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5    <!--
6     $Id: biomaterials.xml 3394 2007-05-28 11:23:40Z martin $
7     
8     Copyright (C) Authors contributing to this file.
9     
10     This file is part of BASE - BioArray Software Environment.
11     Available at http://base.thep.lu.se/
12     
13     BASE is free software; you can redistribute it and/or
14     modify it under the terms of the GNU General Public License
15     as published by the Free Software Foundation; either version 2
16     of the License, or (at your option) any later version.
17     
18     BASE is distributed in the hope that it will be useful,
19     but WITHOUT ANY WARRANTY; without even the implied warranty of
20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21     GNU General Public License for more details.
22     
23     You should have received a copy of the GNU General Public License
24     along with this program; if not, write to the Free Software
25     Foundation, Inc., 59 Temple Place - Suite 330,
26     Boston, MA  02111-1307, USA.
27    -->             
28<chapter id="biomaterials">
29<?dbhtml dir="biomaterials"?>
30 <title>Biomaterials</title>
31 <sect1 id="biomaterial.introduction">
32  <title>Introduction</title>
33  <para> The generic term Biomaterial refers to any biological material used in an Experiment.
34   Biomaterials are subdivided in 4 components, BioSource, Sample, Extract and Labeled Extract. The
35   order use in presenting those entities is not inocuous as it represents the sequence of
36   transformation a source material undergoes until it is in a state compatible with the realization
37   of a microarray Hybridization. This progression is actually mimicked in the BASE2 View menu again
38   to insist on this natural progression. </para>
39  <para>BioSources correspond to the native biological entity used in an experiment prior to any
40   treatment. </para>
41  <para>Samples are central to BASE2 to describe the sample processing. So Samples can be created
42   from other Samples if user want to track sample processing event in a finely granular fashion.</para>
43  <para>Extracts correspond to nucleic acid material extracted from a tissue sample or a cell
44   culture sample.</para>
45  <para>LabeledExtracts correspond to nucleic acid materials which have undergone a marking
46   procedure using a fluorescent or radioactive compound for detection in a microarray assay.</para>
47  <para>BASE2 allows users to create any of the these entities fairly freely, however it is expected
48   that users will follow the natural path of the laboratory workflow.</para>
49 </sect1>
50 <sect1 id="biosource.manage">
51  <title>Managing BioSources</title>
52
53  <sect2 id="biosource.manage.create">
54   <title>Creating BioSources</title>
55   <para>Go to <menuchoice>
56     <guimenu>View</guimenu>
57     <guimenuitem>BioSources</guimenuitem>
58    </menuchoice> , Click on &gbNew; button </para>
59   <para> A 'Create' pop-up window opens, it contains 2 tabs: <guilabel>Biosource</guilabel> and
60     <guilabel>Annotations</guilabel>. </para>
61   <itemizedlist>
62    <listitem>
63     <para>
64      <guilabel>BioSource</guilabel>
65     </para>
66     <para> This tab allows users to enter essential information about a BioSource.</para>
67     <variablelist>
68      <varlistentry>
69       <term>
70        <guilabel>Name</guilabel>
71       </term>
72       <listitem>
73        <para> This is only mandatory field. BASE2 by default assigns 'New Biosource' as name but it
74         is advised to provide unique sensible names, as this may impact exporting in tab2mage
75         format.</para>
76        <para>For more information about tab2mage format and export, please refer to section <xref
77          linkend="experiments_analysis.magexport"/> and section <xref
78          linkend="annotations.bestpractices"/></para>
79       </listitem>
80      </varlistentry>
81      <varlistentry>
82       <term>
83        <guilabel>Description</guilabel>
84       </term>
85       <listitem>
86        <para> A free text description can be supplied using this field.</para>
87       </listitem>
88      </varlistentry>
89      <varlistentry>
90       <term>
91        <guilabel>External id</guilabel>
92       </term>
93       <listitem>
94        <para> An external reference identifiers (e.g. a patient identification code) can be
95         supplied using this field.</para>
96       </listitem>
97      </varlistentry>
98     </variablelist>
99
100     <figure id="write_docbook_doc.figures.biosource-tab-1">
101      <title>The Biosource tab in the Biosource Create Window</title>
102      <screenshot>
103      <mediaobject>
104       <imageobject>
105        <imagedata contentwidth="10cm" width="10cm" fileref="figures/biosource-tab-1.png" format="PNG"/>
106       </imageobject>
107      </mediaobject>
108     </screenshot>
109     </figure>
110    </listitem>
111    <listitem>
112     <para>
113      <guilabel>Annotations</guilabel>
114     </para>
115     <para> This tab allows BASE2 users to use Annotation Types to refine BioSource description.</para>
116     <para>A list of Annotation Type will be displayed only if owned by or shared to the user.</para>
117     <important>
118      <para> In order to use this feature, Annotation Type must be declared and made available. To
119       learn more about Annotation Types, please refer to <xref linkend="annotations"/>
120      </para>
121     </important>
122     <para> Annotation Types can be filtered based on their grouping properties using the
123       <guilabel>categories</guilabel> select-list feature. For more information about Annotation
124      Type Categories, refer to section <xref linkend="annotations.manage.create_atcategory"/>. </para>
125     <figure id="write_docbook_doc.figures.biosource-tab-2">
126      <title>The Annotation tab from the Biosource Create Window</title>
127      <screenshot>
128      <mediaobject>
129       <imageobject>
130        <imagedata contentwidth="10cm" width="10cm" fileref="figures/biosource-tab-2.png" format="PNG"/>
131       </imageobject>
132      </mediaobject>
133     </screenshot>
134     </figure>
135     <para>To provide a value to a specific Annotation Type, click on it.</para>
136     <para> Upon selection, the windows is updated to present a drop-down list, an entry box or a
137      radio-button check box, depending on the type of the Annotation Type.</para>
138     <para>Once a value has been supplied, an <inlinemediaobject>
139       <imageobject>
140        <imagedata fileref="figures/annotated.gif" format="GIF"/>
141       </imageobject>
142      </inlinemediaobject> symbol appear in front of the annotation type.</para>
143     <para>The actual type of the Annotation Type will be reminded between bracket, for instance
144      appearing in the interface as <guilabel>(float)</guilabel> or <guilabel>(string)</guilabel>.</para>
145     <para>A validation will be applied upon data entry to match the requirements, i.e. check for
146      integer,boolean, string... values are provided.</para>
147     <figure id="write_docbook_doc.figures.biosource-tab-3">
148      <title>Providing Annotation Type values from the Biosource Create Window</title>
149      <screenshot>
150      <mediaobject>
151       <imageobject>
152        <imagedata contentwidth="10cm" width="10cm" fileref="figures/biosource-tab-3.png" format="PNG"/>
153       </imageobject>
154      </mediaobject>
155     </screenshot>
156     </figure>
157    </listitem>
158   </itemizedlist>
159   <para>Click on the <inlinemediaobject>
160     <imageobject>
161      <imagedata fileref="figures/save.gif" format="GIF"/>
162     </imageobject>
163    </inlinemediaobject> Save button to store the information in BASE2 or on the <inlinemediaobject>
164     <imageobject>
165      <imagedata fileref="figures/cancel.gif" format="GIF"/>
166     </imageobject>
167    </inlinemediaobject> button to abort. </para>
168  </sect2>
169  <sect2 id="biosource.manage.detail_view">
170   <title>Viewing/Editing BioSources</title>
171   <para>From the BioSource List View, clicking on the BioSource <guilabel>Name</guilabel> opens a
172    detailed view for that Biosource, showing a summary of all information available in BASE2 about
173    that particular entity.</para>
174   <para> The default behavior opens the detailed view on the <guilabel>Properties</guilabel> tab,
175    which shows a summary information and displays the list of Samples derived from a BioSource, if
176    any.</para>
177   <figure id="write_docbook_doc.figures.biosource-itemview-prop">
178    <title>BioSource Item View, properties tab</title>
179    <screenshot>
180    <mediaobject>
181     <imageobject>
182      <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosource-itemview-prop.png" format="PNG"/>
183     </imageobject>
184    </mediaobject>
185   </screenshot>
186   </figure>
187   <para>By clicking on the <guilabel>Annotations</guilabel> tab, users can display the list of
188    Annotation Types used to annotate a Biosource. </para>
189   <figure id="write_docbook_doc.figures.biosource-itemview-annot">
190    <title>BioSource Item View, annotations tab</title>
191    <screenshot>
192    <mediaobject>
193     <imageobject>
194      <imagedata contentwidth="13cm" width="13cm" fileref="figures/biosource-itemview-annot.png" format="PNG"/>
195     </imageobject>
196    </mediaobject>
197   </screenshot>
198   </figure>
199   <para>Clicking the <inlinemediaobject>
200     <imageobject>
201      <imagedata fileref="figures/edit.gif" format="GIF"/>
202     </imageobject>
203    </inlinemediaobject><guiicon> edit icon</guiicon> in the <interface>value</interface> for any of
204    the annotations (e.g. 'antibiotic' in our example), opens an Annotate window (which is a
205    BioSource Edit window set on the annotation tab) and highlights the selected Annotation Type,
206    prompting for data entry.</para>
207   <figure id="write_docbook_doc.figures.biosource-itemview-annot-edit">
208    <title>BioSource annotations edit</title>
209    <screenshot>
210    <mediaobject>
211     <imageobject>
212      <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosource-itemview-annot-edit.png" format="PNG"/>
213     </imageobject>
214    </mediaobject>
215   </screenshot>
216   </figure>
217   <para> The relevant Annotation Type is highlighted and a list of possible values is displayed. </para>
218   <para>Again, all Annotation types marked with a <inlinemediaobject>
219     <imageobject>
220      <imagedata fileref="figures/annotated.gif" format="GIF"/>
221     </imageobject>
222    </inlinemediaobject> symbol have been used to provided information.</para>
223   <para>Click on the <inlinemediaobject>
224     <imageobject>
225      <imagedata fileref="figures/save.gif" format="GIF"/>
226     </imageobject>
227    </inlinemediaobject> Save button to store the information in BASE2 or on the <inlinemediaobject>
228     <imageobject>
229      <imagedata fileref="figures/cancel.gif" format="GIF"/>
230     </imageobject>
231    </inlinemediaobject> button to abort. </para>
232  </sect2>
233  <sect2 id="biosource.manage.delete_restore">
234   <title>Deleting/Restoring BioSources</title>
235   <para>As for other items in BASE2, BioSources can be removed. For a generic overview on how to
236    delete and restore items, refer to section <xref linkend="webclient.items.delete"/>
237   </para>
238   <para> To delete, do the following</para>
239   <itemizedlist>
240    <listitem>
241     <para> Select one or more BioSources and click &gbDelete; button in the menu
242      bar. </para>
243     <para> All the selected BioSources have been marked as deleted and are no longer available from
244      the interface. </para>
245     <para> From the <guilabel>view/preset&hellip;</guilabel> select box, ticking the
246       <guilabel>Removed</guilabel> option allows to display those of the BioSources earmarked for
247      deletion. They will be shown with a symbol <inlinemediaobject>
248       <imageobject>
249        <imagedata fileref="figures/deleted.gif" format="GIF"/>
250       </imageobject>
251      </inlinemediaobject> in front of them. </para>
252    </listitem>
253    <listitem>
254     <para> Alternately, navigating to the BioSource Item View, hitting the
255      &gbDelete; will perform the task.</para>
256     <para> As shown in the next picture, the BioSource is then marked with the <inlinemediaobject>
257       <imageobject>
258        <imagedata fileref="figures/deleted.gif" format="GIF"/>
259       </imageobject>
260      </inlinemediaobject><guilabel>This item has been flagged for deletion</guilabel> label.</para>
261     <figure id="write_docbook_doc.figures.biosource-delete">
262      <title>Deleting BioSource from the Item View</title>
263      <screenshot>
264     <mediaobject>
265      <imageobject>
266       <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosource-delete.png" format="PNG"/>
267      </imageobject>
268     </mediaobject>
269    </screenshot>
270     </figure>
271    </listitem>
272    <listitem>
273     <para>Deletion errors can be easily recovered. Select the item to recover from the List View
274      (be sure to check the <guilabel>Removed</guilabel> option in the View/preset.. filter) and hit
275      the &gbRestore; to performed the task. </para>
276    </listitem>
277   </itemizedlist>
278   <important>
279    <para>To really delete an item from the database you must use the trashcan. Items deleted from
280     the Trashcan can not be recovered. To learn more about the trashcan function, please refer to
281      <xref linkend="trashcan"/>
282    </para>
283   </important>
284  </sect2>
285 </sect1>
286 <sect1 id="sample.manage">
287  <title>Managing Samples</title>
288  <para>Samples result from processing events applied to <guilabel>BioSource</guilabel> material or
289   other <guilabel>Samples</guilabel> before they are turned into an <guilabel>Extract</guilabel>.</para>
290  <para>In other words, Samples can be created from BioSource items or from one or more Sample
291   items.</para>
292  <para>When a Sample is created from several other Samples, a 'pooling' event is performed. A
293   specific section details how to create pools, refer to <xref
294    linkend="sample.manage.createsample.pool"/></para>
295  <para>For every step of transformation from BioSource to Sample, it is possible to provide
296   information about the protocol used to perform this task. It is not enforced in BASE2 but it
297   should serve as guidance when devising the granularity of the sample processing task. Also, it is
298   good practice to provide protocol information to ensure MIAME compliance.</para>
299  <sect2 id="sample.manage.createsamplefrombiosource">
300   <title>Creating Samples</title>
301   <orderedlist>
302    <listitem>
303     <para>Creating Samples from the BioSource page</para>
304     <para>No matter how complex the sample processing phase is, at least one Sample has to be
305      anchored to a BioSource.</para>
306     <para>Therefore, a natural way to create a Sample is to click on the <inlinemediaobject>
307       <imageobject>
308        <imagedata fileref="figures/add.gif" format="GIF"/>
309       </imageobject>
310      </inlinemediaobject>
311      <guibutton>Create new Sample</guibutton> from the Sample column of the BioSource list view.</para>
312     <figure id="write_docbook_doc.figures.biosource-create-sample">
313      <title>Creating a Sample from the BioSource list view</title>
314      <screenshot>
315       <mediaobject>
316        <imageobject>
317         <imagedata contentwidth="13cm" width="13cm" fileref="figures/biosource-create-sample.png" format="PNG"/>
318        </imageobject>
319       </mediaobject>
320      </screenshot>
321     </figure>
322    </listitem>
323    <listitem>
324     <para>Creating Samples from the Sample List view page</para>
325     <para> This is the alternative for creating Sample from the BioSource. To do so, go to <menuchoice>
326       <guimenu>View</guimenu>
327       <guimenuitem>BioSamples</guimenuitem>
328      </menuchoice> , Click on &gbNew; button </para>
329     <para> A 'Create' pop-up window opens, it contains 4 tabs: <guilabel>Sample</guilabel>,
330       <guilabel>Parents</guilabel>, <guilabel> Annotations &amp; parameters</guilabel> and
331       <guilabel>Inherited Annotations</guilabel>. </para>
332     <itemizedlist>
333      <listitem>
334       <para>The Sample Tab </para>
335       <para>This tab contains 1 mandatory field for providing the Sample <guilabel>Name</guilabel>.
336        BASE2 by default assigns names to Samples (by suffixing 's#' when creating a Sample from an
337        existing Biosource or 'New Sample' otherwise) but it is possible to edit at will.</para>
338       <para>There are 5 optional fields to provide more detailed information</para>
339       <itemizedlist>
340        <listitem>
341         <para><guilabel>External ID</guilabel>: for instance to report a barcode attached to a
342          Sample</para>
343        </listitem>
344        <listitem>
345         <para><guilabel>Original Quantity (ug)</guilabel>: this is meant to report information
346          about the actual mass of biomaterial created</para>
347        </listitem>
348        <listitem>
349         <para><guilabel>Created</guilabel>: a date should be provided. The information can be
350          important when running quality controls on data and account for potential confounding
351          factor (e.g. day effect)</para>
352        </listitem>
353        <listitem>
354         <para><guilabel>Protocol</guilabel>: this a controled field. A select-list displays
355          protocols whose type is <guilabel>sampling</guilabel> and which are shared to or owned by
356          the logged-in user. </para>
357         <important>
358          <para>It is not mandatory to supply protocol in BASE2 Reporting protocols is a MIAME
359           requirement</para>
360         </important>
361        </listitem>
362        <listitem>
363         <para><guilabel>Description</guilabel>: a free text field to report any information that
364          not can be captured otherwise</para>
365        </listitem>
366       </itemizedlist>
367       <para>Finally, a 7th field, <guilabel>Registered</guilabel> is automatically populated with a
368        date at which the Sample was entered in BASE2 system.</para>
369       <figure id="write_docbook_doc.figures.biosample-tab-1">
370        <title>Sample tab</title>
371        <screenshot>
372         <mediaobject>
373          <imageobject>
374           <imagedata contentwidth="10cm" width="10cm" fileref="figures/biosample-tab-1.png" format="PNG"/>
375          </imageobject>
376         </mediaobject>
377        </screenshot>
378       </figure>
379      </listitem>
380      <listitem>
381       <para>The Parents Tab </para>
382       <para>This important tab does what it says on the tin: It is meant to keep track of the
383        Sample origin. BASE2 distinguished between 2 cases which are controled by the
384         <guibutton>pooled</guibutton> radio-button</para>
385       <orderedlist>
386        <listitem>
387         <para>The Parent is a BioSource</para>
388         <para> The <guibutton>Pooled</guibutton> radio-button is set to <guilabel>No</guilabel></para>
389         <para> The BioSource select button is active and allows users to point to one and only one
390          BioSource from which the Sample originates from.</para>
391         <figure id="write_docbook_doc.figures.biosample-tab-2-select-biosource">
392          <title>Parent tab and interaction when pooled button is set to No</title>
393          <screenshot>
394           <mediaobject>
395            <imageobject>
396             <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-2-select-biosource.png" format="PNG"/>
397            </imageobject>
398           </mediaobject>
399          </screenshot>
400         </figure>
401        </listitem>
402        <listitem>
403         <para>The Parent is another Sample</para>
404         <para> The <guibutton>Pooled</guibutton> radio-button has to be set to
405          <guilabel>Yes</guilabel></para>
406         <para>Upon selection, the BioSource select button is deactivated and the Samples box and
407          button are activated.</para>
408         <para>This allows users to specify one or more Samples to be selected from the Sample List
409          View page. </para>
410         <figure id="write_docbook_doc.figures.biosample-tab-2-select-sample">
411          <title>Parent tab and interaction when pooled button is set to Yes</title>
412          <screenshot>
413           <mediaobject>
414            <imageobject>
415             <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-2-select-sample.png" format="PNG"/>
416            </imageobject>
417           </mediaobject>
418          </screenshot>
419         </figure>
420        </listitem>
421       </orderedlist>
422      </listitem>
423      <listitem>
424       <para>Annotations &amp; parameters </para>
425       <para>As seen in the BioSource section, this tab allows users to further supply information
426        about the Sample provided they have defined or shared annotation types to annotate Sample
427        items.</para>
428       <para>The display of Annotation Type can be filtered based on the Annotation Type Category
429        they belong to. </para>
430       <important>
431        <para> In order to use this feature, Annotation Type must be declared and made available. To
432         learn more about Annotation Types, please refer to <xref linkend="annotations"/>
433        </para>
434       </important>
435       <para>To provide a value for a given annotation type, simply click on it an use the input
436        field or select a value from the drop-down lists or radio buttons.</para>
437       <figure id="write_docbook_doc.figures.biosample-tab-3">
438        <title>Annotations &amp; parameters</title>
439        <screenshot>
440         <mediaobject>
441          <imageobject>
442           <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-3.png" format="PNG"/>
443          </imageobject>
444         </mediaobject>
445        </screenshot>
446       </figure>
447      </listitem>
448      <listitem>
449       <para>Inherited Annotations case1 </para>
450       <para>The next picture shows </para>
451       <figure id="write_docbook_doc.figures.biosample-tab-4">
452        <title>Inherited Annotations</title>
453        <screenshot>
454         <mediaobject>
455          <imageobject>
456           <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-4.png" format="PNG"/>
457          </imageobject>
458         </mediaobject>
459        </screenshot>
460       </figure>
461       <para>Inherited Annotations case2</para>
462       <figure id="write_docbook_doc.figures.biosample-tab-4bis">
463        <title>Inherited Annotations</title>
464        <screenshot>
465         <mediaobject>
466          <imageobject>
467           <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-4bis.png" format="PNG"/>
468          </imageobject>
469         </mediaobject>
470        </screenshot>
471       </figure>
472      </listitem>
473     </itemizedlist>
474    </listitem>
475   </orderedlist>
476  </sect2>
477  <sect2 id="sample.manage.createsample.pool">
478   <title>Creating Pooled Samples</title>
479   <para>It is common practice when biological material is scarce to pool Samples from equivalent
480    sources. BASE2 provides mechanisms to report on such practice.</para>
481   <para>This section details how.</para>
482   <para>There are 2 ways to create Pooled Samples in BASE2</para>
483   <orderedlist>
484    <listitem>
485     <para>Using the Pooled radio button option from the Sample Create page, and this has been shown
486      already </para>
487    </listitem>
488    <listitem>
489     <para>Using the Pool button in the Menu bar</para>
490     <para>The Sample List View page menu bar contains an additionnal button the usage of which is
491      detailed now.</para>
492     <para>The &gbPool; button <inlinemediaobject>
493       <imageobject>
494        <imagedata fileref="figures/new_pooled.gif" format="GIF"/>
495       </imageobject>
496      </inlinemediaobject> allows users to create Pooled Samples by selecting the list of Samples
497      used to produce that new Sample.</para>
498     <para> Users simply need to tick the select-boxes in front of each relevant Sample and click
499      the <inlinemediaobject>
500       <imageobject>
501        <imagedata fileref="figures/new_pooled.gif" format="GIF"/>
502       </imageobject>
503      </inlinemediaobject> button. </para>
504     <para>This provides an easy and simple way to create Pooled Samples. The result of such process
505      is the creation of a New Sample, which Parent Samples are listing and preset in the Parent tab</para>
506     <figure id="write_docbook_doc.figures.biosample-tab-2-pool-sample">
507      <title>Pooling of Samples</title>
508      <screenshot>
509       <mediaobject>
510        <imageobject>
511         <imagedata contentwidth="12cm" width="12cm" fileref="figures/biosample-tab-2-pool-sample.png" format="PNG"/>
512        </imageobject>
513       </mediaobject>
514      </screenshot>
515     </figure>
516    </listitem>
517   </orderedlist>
518  </sect2>
519  <sect2 id="sample.manage.delete">
520   <title>Deleting/Restoring Samples</title>
521   <para>As for other items in BASE2, Samples can be removed. For a generic overview on how to
522    delete and restore items, refer to section <xref linkend="webclient.items.delete"/></para>
523   <para>To delete, do the following</para>
524   <itemizedlist>
525    <listitem>
526     <para> Select one or more Samples and click &gbDelete; button in the menu
527      bar. </para>
528     <para> All the selected Samples have been marked as deleted and are no longer available from
529      the interface. </para>
530     <para> From the <guilabel>view/preset&hellip;</guilabel> select box, ticking the
531       <guilabel>Removed</guilabel> option allows to display those Samples earmarked for deletion.
532      They will be shown with a symbol <guiicon>D</guiicon> in front of them. </para>
533    </listitem>
534    <listitem>
535     <para> Alternately, navigating to the Sample Item View, one can hit the
536      &gbDelete; to performed the task. As showen in the next picture, the Sample
537      is then flagged with the <guiicon>This item has been flagged for deletion</guiicon>
538     </para>
539     <figure id="write_docbook_doc.figures.sample-delete">
540      <title>Deleting Samples from the Item View</title>
541      <screenshot>
542     <mediaobject>
543      <imageobject>
544       <imagedata contentwidth="12cm" width="12cm" fileref="figures/sample-delete.png" format="PNG"/>
545      </imageobject>
546     </mediaobject>
547    </screenshot>
548     </figure>
549    </listitem>
550    <listitem>
551     <para>Deletion errors can be easily recovered. Select the item to recover from the List View
552      (be sure to check the <guilabel>removed</guilabel> option in the View/preset.. filter) and hit
553      the &gbRestore; to performed the task. </para>
554    </listitem>
555   </itemizedlist>
556   <important>
557    <para>To really delete an item from the database you must use the trashcan. Items deleted from
558     the Trashcan can not be recovered. To learn more about the trashcan function, please refer to
559      <xref linkend="trashcan"/>
560    </para>
561   </important>
562  </sect2>
563 </sect1>
564
565 <sect1 id="extract.manage">
566  <title>Managing Extracts</title>
567  <para>Extract items should be used to describe the events that transform a Sample material in an
568   Extract material.</para>
569  <para>Extracts can be created from Sample items or from one or more Extract items.</para>
570  <para>When an Extract is created from several other Extracts, a Pooling event is performed. A
571   specific section details how to create pooled Extracts</para>
572  <para>During the transformation from Samples to Extracts, it is possible to provide information
573   about the protocol used to perform this task.</para>
574  <para>It is not enforced in BASE2 but it should serve as guidance when devising the granularity of
575   the sample processing task. Also, it is good practice to provide protocol information.</para>
576  <sect2 id="extract.manage.createextractfromsample">
577   <title>Creating Extracts</title>
578   <orderedlist>
579    <listitem>
580     <para>Creating Extracts from the Sample page</para>
581     <para>Following the laboratory workflow, a natural way to create a new Extract is to click on
582      the <guibutton>New extract</guibutton> from the Extract column of the Sample List View.</para>
583     <figure id="write_docbook_doc.figures.sample-create-extract">
584      <title>Creating an Extract from the Sample list view</title>
585      <screenshot>
586       <mediaobject>
587        <imageobject>
588         <imagedata contentwidth="12cm" width="12cm" fileref="figures/sample-create-extract.png" format="PNG"/>
589        </imageobject>
590       </mediaobject>
591      </screenshot>
592     </figure>
593    </listitem>
594    <listitem>
595     <para>Creating Extracts from the Sample List view page</para>
596     <para> Alternately, Extracts can be created directly ysing the Extract create page. To do so,
597      go to <menuchoice>
598       <guimenu>View</guimenu>
599       <guimenuitem>Extracts</guimenuitem>
600      </menuchoice> , Click on &gbNew; button </para>
601     <para> A 'Create' pop-up window opens, it contains 4 tabs: <guilabel>Extract</guilabel>,
602       <guilabel>Parents</guilabel>, <guilabel> Annotations &amp; parameters</guilabel> and
603       <guilabel>Inherited Annotations</guilabel>. </para>
604     <itemizedlist>
605      <listitem>
606       <para>The Extract Tab </para>
607       <para>This tab contains 1 mandatory field for providing the extract name. </para>
608       <para>BASE2 by default assigns names to Extract (by suffixing 'e#' when creating an Extract
609        from an existing Sample or 'New Extract' otherwise) but it is possible to edit it at will</para>
610       <para>There 5 optional fields to provide more detailed information</para>
611       <itemizedlist>
612        <listitem>
613         <para><guilabel>External ID</guilabel>: for instance to report a barcode attached to an
614          extract</para>
615        </listitem>
616        <listitem>
617         <para><guilabel>Original Quantity (ug)</guilabel>: this is meant to report information
618          about the actual mass of biomaterial created</para>
619        </listitem>
620        <listitem>
621         <para><guilabel>Created</guilabel>: a date should be provided. The information can be
622          important when running quality controls on data and account for potential confounding
623          factor (e.g. day effect)</para>
624        </listitem>
625        <listitem>
626         <para><guilabel>Protocol</guilabel>: this a controled field. A select-list displays
627          protocol whose type is '<guilabel>extraction</guilabel>' and which are shared to or owned
628          by the logged-in user. Reporting Protocol should be viewed as a MIAME requirement</para>
629        </listitem>
630        <listitem>
631         <para><guilabel>Description</guilabel>: a free text field to report any information that
632          not can be captured otherwise</para>
633        </listitem>
634       </itemizedlist>
635       <para>Finally, a 7th field <guilabel>Registered</guilabel> is automatically populated with a
636        date at which the sample was entered in BASE2 system.</para>
637       <figure id="write_docbook_doc.figures.extract-tab-1">
638        <title>Extract tab</title>
639        <screenshot>
640         <mediaobject>
641          <imageobject>
642           <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-1.png" format="PNG"/>
643          </imageobject>
644         </mediaobject>
645        </screenshot>
646       </figure>
647      </listitem>
648      <listitem>
649       <para>The Parents Tab </para>
650       <para>This important tab allows users to select the Extract origin. BASE2 distinguished
651        between 2 cases which are controled by the <guibutton>'pooled'</guibutton> radio-button</para>
652       <orderedlist>
653        <listitem>
654         <para>The Parent is a Sample</para>
655         <para> The <guibutton>pooled</guibutton> radio-button is set to <guilabel>No</guilabel></para>
656         <para> The Sample select button is active and allows users to point to one and only one
657          Sample from which the sample originates from.</para>
658         <figure id="write_docbook_doc.figures.extract-tab-2-select-sample">
659          <title>Parent tab and interaction when pooled button is set to No</title>
660          <screenshot>
661           <mediaobject>
662            <imageobject>
663             <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-2-select-sample.png" format="PNG"/>
664            </imageobject>
665           </mediaobject>
666          </screenshot>
667         </figure>
668        </listitem>
669        <listitem>
670         <para>The Parent is another Extract</para>
671         <para> The <guibutton>pooled</guibutton> radio-button has to be set to
672          <guilabel>Yes</guilabel></para>
673         <para>Upon selection, the Samples select button is deactivated and the Extracts box and
674          button are activated.</para>
675         <para>This allows users to specify one or more extracts to be selected from the Extract
676          list View page.</para>
677         <figure id="write_docbook_doc.figures.extract-tab-2-select-extract">
678          <title>Parent tab and interaction when pooled button is set to Yes</title>
679          <screenshot>
680           <mediaobject>
681            <imageobject>
682              <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-2-select-extract.png" format="PNG"/>
683            </imageobject>
684           </mediaobject>
685          </screenshot>
686         </figure>
687        </listitem>
688       </orderedlist>
689      </listitem>
690      <listitem>
691       <para>Annotations &amp; parameters </para>
692       <para>As seen in the BioSource and Sample sections, this tab allows users to supply further
693        information about the Extract, provided they have defined Annotation Types to annotation
694        Extract items or have such elements shared to them.</para>
695       <para>The display of Annotation Type can be filtered based on the Annotation Type Category
696        they belong to.</para>
697       <important>
698        <para> In order to use this feature, Annotation Type must be declared and made available. To
699         learn more about Annotation Types, please refer to <xref linkend="annotations"/>
700        </para>
701       </important>
702       <para>To provide a value for a given annotation type, simply click on it an use the input
703        field or select a value from the drop-down lists or radio buttons.</para>
704       <figure id="write_docbook_doc.figures.extract-tab-3">
705        <title>Annotations &amp; parameters</title>
706        <screenshot>
707         <mediaobject>
708          <imageobject>
709           <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-3.png" format="PNG"/>
710          </imageobject>
711         </mediaobject>
712        </screenshot>
713       </figure>
714      </listitem>
715      <listitem>
716       <para>Inherited Annotations case1 </para>
717       <para>The next picture shows </para>
718       <figure id="write_docbook_doc.figures.extract-tab-4">
719        <title>Inherited Annotations</title>
720        <screenshot>
721         <mediaobject>
722          <imageobject>
723           <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-4.png" format="PNG"/>
724          </imageobject>
725         </mediaobject>
726        </screenshot>
727       </figure>
728      </listitem>
729     </itemizedlist>
730    </listitem>
731   </orderedlist>
732  </sect2>
733  <sect2 id="extract.manage.createextractpool">
734   <title>Creating Pooled Extracts</title>
735   <para>It is common practice when biological material is scarce to pool extracts from equivalent
736    sources. BASE2 provides mechanisms to report on such practice. This section details how.</para>
737   <para>There are 2 ways to create pooled samples in BASE2:</para>
738   <orderedlist>
739    <listitem>
740     <para>Using the Pooled radio button option from the Extract Create page, and this has been
741      shown already.</para>
742    </listitem>
743    <listitem>
744     <para>Using the Pool button in the Menu bar</para>
745     <para>The Sample List View page menu bar contains an addition &gbPool;
746      <inlinemediaobject>
747       <imageobject>
748        <imagedata fileref="figures/new_pooled.gif" format="GIF"/>
749       </imageobject>
750      </inlinemediaobject> button, the usage of which is detailed now.</para>
751     <para>The &gbPool;
752      <inlinemediaobject>
753       <imageobject>
754        <imagedata fileref="figures/new_pooled.gif" format="GIF"/>
755       </imageobject>
756      </inlinemediaobject> button allows users to create Pooled Extracts by selecting the list of
757      Extracts used to derived a new Extract. Users simply to tick to boxes in front of each
758      relevant Extract and click the <guibutton>Pool...</guibutton></para>
759     <para>This provides an easy and simple way to create pooled Extracts. The result of such
760      process is the creation of a New Extract, in which, when navigating to the Parent tab, shows
761      that all the Extracts involved are already set and listed in the Extract box of the tab.</para>
762     <figure id="write_docbook_doc.figures.biosample-tab-2-pool-extract">
763      <title>Pooling of Extracts</title>
764      <screenshot>
765       <mediaobject>
766        <imageobject>
767         <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-tab-2-pool-extract.png" format="PNG"/>
768        </imageobject>
769       </mediaobject>
770      </screenshot>
771     </figure>
772    </listitem>
773   </orderedlist>
774  </sect2>
775  <sect2 id="extract.manage.delete">
776   <title>Deleting/Restoring Extracts</title>
777   <para>As for other items in BASE2, Extracts can be removed. For a generic overview on how to
778    delete and restore items, refer to section <xref linkend="webclient.items.delete"/>
779   </para>
780   <para>To delete, do the following</para>
781   <itemizedlist>
782    <listitem>
783     <para> Select one or more Extract and click &gbDelete; button in the menu
784      bar.</para>
785     <para> All the selected Extracts have been marked as deleted and are no longer available from
786      the interface.</para>
787     <para> Only by selecting from the <guilabel>view/preset&hellip;</guilabel> select box the
788       <guilabel>Removed</guilabel> option, one can see those of the Extracts earmarked for
789      deletion. They will be shown with a symbol in front of them.</para>
790    </listitem>
791    <listitem>
792     <para> Alternately, navigating to the Extract Item View, one can hit the
793      &gbDelete; to performed the task.</para>
794     <para> As shown in the next picture, the Extract is then marked with the <guilabel>This item
795       has been flagged for deletion</guilabel>
796     </para>
797     <figure id="write_docbook_doc.figures.extract-delete">
798      <title>Deleting Extracts from the Item View</title>
799      <screenshot>
800       <mediaobject>
801        <imageobject>
802         <imagedata contentwidth="12cm" width="12cm" fileref="figures/extract-delete.png" format="PNG"/>
803        </imageobject>
804       </mediaobject>
805      </screenshot>
806     </figure>
807    </listitem>
808    <listitem>
809     <para>Deletion errors at this stage can be easily recovered. Select the item to recover from
810      the List View (be sure to check the <guilabel>removed</guilabel> option in the View/preset..
811      filter) and hit the &gbRestore; to performed the task. </para>
812    </listitem>
813   </itemizedlist>
814   <important>
815    <para>To really delete an item from the database you must use the trashcan. Items deleted from
816     the Trashcan can not be recovered. To learn more about the trashcan function, please refer to
817      <xref linkend="trashcan"/>
818    </para>
819   </important>
820  </sect2>
821 </sect1>
822
823
824
825 <sect1 id="label">
826  <title>Managing Labels</title>
827
828  <sect2 id="label.browse">
829   <title>Browsing Labels</title>
830   <para>Before attempting to create Labeled Extracts, users should make sure that the appropriate
831    Label object is present in BASE2</para>
832   <para>To browse the list of Labels, go to <menuchoice>
833     <guimenu>View</guimenu>
834     <guimenuitem>Labels</guimenuitem>
835    </menuchoice> It is wise to select the clear filter option or select the <guilabel>shared to
836    me</guilabel> option from the view/preset select box in order to view all different dyes.</para>
837   <para>Clicking on any of item opens an item view page</para>
838   <figure id="write_docbook_doc.figures.label-itemview">
839    <title>The Label Item View Page</title>
840    <screenshot>
841     <mediaobject>
842      <imageobject>
843       <imagedata contentwidth="12cm" width="12cm" fileref="figures/label-itemview.png" format="PNG"/>
844      </imageobject>
845     </mediaobject>
846    </screenshot>
847   </figure>
848   <para>Note the <guibutton>New labeled extract&hellip;</guibutton> button available from this page. For
849    more detailed about creating Labeled extracts, see <xref linkend="labeledextract.manage"/></para>
850
851  </sect2>
852  <sect2 id="label.create">
853   <title>Creating Labels</title>
854   <para> Click on &gbNew; button, a pop-up window opens. Fill in
855    Name and description if required. Label item are very simple object and do not bear association
856    to Annotation Type. </para>
857  </sect2>
858 </sect1>
859 <sect1 id="labeledextract.manage">
860  <title>Managing Labeled Extracts</title>
861  <para>Labeled Extract items should be used to describe the event that transformed a Extract
862   material in a Labeled Extract material.</para>
863  <para>Labeled extracts can be created from Extract items or from one or more Labeled extract
864   items.</para>
865  <para>When a Labeled Extract is created from several other Labeled Extracts, a Pooling event is
866   performed. A specific section details how to create pooled Labeled Extracts</para>
867  <para>During the transformation from Extracts to Labeled Extracts, it is possible to provide
868   information about the protocol used to perform this task.</para>
869  <para>It is not enforced in BASE2 but it should serve as guidance when devising the granularity of
870   the extract processing task. Also, it is good practice to provide protocol information.</para>
871  <sect2 id="labeledextract.manage.createlabeledextractfromextract">
872   <title>Creating Labeled Extracts</title>
873   <orderedlist>
874    <listitem>
875     <para>Creating Labeled Extracts from the Extract page</para>
876     <para>Following the laboratory workflow, a natural way to create a Labeled Extract is to click
877      on the <guibutton>New labeled extract</guibutton> from the Labeled Extract column of the
878      Extract List View.</para>
879     <figure id="write_docbook_doc.figures.sample-create-labeledextract">
880      <title>Creating a Labeled Extract from the Extract List View</title>
881      <screenshot>
882       <mediaobject>
883        <imageobject>
884         <imagedata contentwidth="12cm" width="12cm" fileref="figures/sample-create-labeledextract.png" format="PNG"/>
885        </imageobject>
886       </mediaobject>
887      </screenshot>
888     </figure>
889    </listitem>
890    <listitem>
891     <para>Creating Labeled Extracts from the Extract Item View page</para>
892     <para> Alternately, Labeled Extracts can be created directly using the Labeled Extract create
893      page. To do so, go to <menuchoice>
894       <guimenu>View</guimenu>
895       <guimenuitem>Labeled Extracts</guimenuitem>
896      </menuchoice> , Click on &gbNew; button </para>
897     <para> A 'Create' pop-up window opens, it contains 4 tabs: <guilabel>Labeled
898      Extract</guilabel>, <guilabel>Parents</guilabel>, <guilabel> Annotations &amp;
899      parameters</guilabel> and <guilabel>Inherited Annotations</guilabel>. </para>
900     <itemizedlist>
901      <listitem>
902       <para>The Labeled Extract Tab </para>
903       <para>This tab contains 2 mandatory fields, one for providing the Labeled Extract
904         <guilabel>Name</guilabel>, the other one <guilabel>Label</guilabel> to specify which dye or
905        marker was used in the labeling reaction.</para>
906       <para> BASE2 by default assigns names to Labeled Extract(by suffixing 'lbe#' when creating a
907        Labeled Extract from an existing Extract or 'New labeled extract' otherwise) but it is
908        possible to edit it at will</para>
909       <para>There 5 optional fields to provide more detailed information</para>
910       <itemizedlist>
911        <listitem>
912         <para><guilabel>External ID</guilabel>: for instance to report a barcode attached to an
913          extract</para>
914        </listitem>
915        <listitem>
916         <para><guilabel>Original Quantity (ug)</guilabel>: this is meant to report information
917          about the actual mass of biomaterial created</para>
918        </listitem>
919        <listitem>
920         <para><guilabel>Created</guilabel>: a date should be provided. The information can be
921          important when running quality controls on data and account for potential confounding
922          factor (e.g. day effect)</para>
923        </listitem>
924        <listitem>
925         <para><guilabel>Protocol</guilabel>: this a controled field. A select-list displays
926          protocol whose type is '<guilabel>labeling</guilabel>' and which are shared to or owned by
927          the logged-in user. Reporting Protocol should be viewed as a MIAME requirement</para>
928        </listitem>
929        <listitem>
930         <para><guilabel>Description</guilabel>: a free text field to report any information that
931          can not be captured otherwise</para>
932        </listitem>
933       </itemizedlist>
934       <para>Finally, a 7th field <guilabel>Created</guilabel> is automatically populated with a
935        date at which the Labeled Extract was actually entered in BASE2 system.</para>
936       <figure id="write_docbook_doc.figures.labeledextract-tab-1">
937        <title>Labeled Extract tab</title>
938        <screenshot>
939         <mediaobject>
940          <imageobject>
941           <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-1.png" format="PNG"/>
942          </imageobject>
943         </mediaobject>
944        </screenshot>
945       </figure>
946      </listitem>
947      <listitem>
948       <para>The Parents Tab </para>
949       <para>This important tab allows users to select the Labeled Extract origin. BASE2
950        distinguished between 2 cases which are controled by the <guibutton>'pooled'</guibutton>
951        radio-button</para>
952       <orderedlist>
953        <listitem>
954         <para>The Parent is an Extract</para>
955         <para> The <guibutton>pooled</guibutton> radio-button is set to <guilabel>No</guilabel></para>
956         <para> The Extract select button is active and allows users to point to one and only one
957          Extract from which the Labeled Extract originates from.</para>
958         <figure id="write_docbook_doc.figures.labeledextract-tab-2-select-extract">
959          <title>Parent tab and interaction when pooled button is set to No</title>
960          <screenshot>
961           <mediaobject>
962            <imageobject>
963             <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-2-select-extract.png" format="PNG"/>
964            </imageobject>
965           </mediaobject>
966          </screenshot>
967         </figure>
968        </listitem>
969        <listitem>
970         <para>The Parent is another Labeled Extract</para>
971         <para> The <guibutton>pooled</guibutton> radio-button has to be set to
972          <guilabel>Yes</guilabel></para>
973         <para>Upon selection, the Extract select button is deactivated and the Labeled Extracts box
974          and button are activated. </para>
975         <para>This allows users to specify one or more extracts to be selected from the Labeled
976          Extract list View page. </para>
977         <figure id="write_docbook_doc.figures.labeledextract-tab-2-select-labeledextract">
978          <title>Parent tab and interaction when pooled button is set to Yes</title>
979          <screenshot>
980           <mediaobject>
981            <imageobject>
982             <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-2-select-labeledextract.png" format="PNG"/>
983            </imageobject>
984           </mediaobject>
985          </screenshot>
986         </figure>
987        </listitem>
988       </orderedlist>
989      </listitem>
990      <listitem>
991       <para>Annotations &amp; parameters </para>
992       <para>As seen in the BioSource and Sample sections, this tab allows users to further supply
993        information about the labeled extract provided they have defined annotation types to
994        annotate Labeled Extract items or have such elements shared to them.</para>
995       <para>The display of Annotation Types can be filtered based on the Annotation Type Categories
996        they belong to.</para>
997       <important>
998        <para> In order to use this feature, Annotation Type must be declared and made available. To
999         learn more about Annotation Types, please refer to <xref linkend="annotations"/>
1000        </para>
1001       </important>
1002       <para>To provide a value for a given annotation type, simply click on it an use the input
1003        field or select a value from the drop-down lists or radio buttons.</para>
1004       <figure id="write_docbook_doc.figures.labeledextract-tab-3">
1005        <title>Annotations &amp; parameters</title>
1006        <screenshot>
1007         <mediaobject>
1008          <imageobject>
1009           <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-3.png" format="PNG"/>
1010          </imageobject>
1011         </mediaobject>
1012        </screenshot>
1013       </figure>
1014      </listitem>
1015      <listitem>
1016       <para>Inherited Annotations case1 </para>
1017       <para>The next picture shows </para>
1018       <figure id="write_docbook_doc.figures.labeledextract-tab-4">
1019        <title>Inherited Annotations</title>
1020        <screenshot>
1021         <mediaobject>
1022          <imageobject>
1023           <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-4.png" format="PNG"/>
1024          </imageobject>
1025         </mediaobject>
1026        </screenshot>
1027       </figure>
1028      </listitem>
1029     </itemizedlist>
1030    </listitem>
1031   </orderedlist>
1032  </sect2>
1033  <sect2 id="labeledextract.manage.createelabeledxtract.pool">
1034   <title>Creating Pooled Labeled Extracts</title>
1035   <para>It is common practice when biological material is scarce to pool extracts from equivalent
1036    sources. BASE2 provides mechanisms to report on such practice.</para>
1037   <para>This section details how.</para>
1038   <para>There are 2 ways to create pooled Labeled Extracts in BASE2</para>
1039   <orderedlist>
1040    <listitem>
1041     <para>Using the Pooled radio button option from the Labeled Extract Create page, and this has
1042      been shown already </para>
1043    </listitem>
1044    <listitem>
1045     <para>Using the Pool button in the Menu bar</para>
1046     <para>The Labeled Extracts List View page menu bar contains an addition
1047       &gbPool; button, the usage of which is detailed now.</para>
1048     <para>The &gbPool; button <inlinemediaobject>
1049       <imageobject>
1050        <imagedata fileref="figures/new_pooled.gif" format="GIF"/>
1051       </imageobject>
1052      </inlinemediaobject> allows users to create Pooled Labeled Extracts by selecting the list of
1053      Labeled Extracts used to derived a new Labeled Extract. Users simply have to tick to boxes in
1054      front of each relevant Labeled Extract and click the <guibutton>Pool...</guibutton></para>
1055     <para>This provides an easy and simple way to create pooled Labeled Extracts. The result of
1056      such process is the creation of a New Labeled Extract, in which, when navigating to the Parent
1057      tab, shows that all the Labeled Extracts involved are already set and listed in the Labeled
1058      Extract box of the tab.</para>
1059     <figure id="write_docbook_doc.figures.labeledextract-tab-2-pool-labeledextract">
1060      <title>Pooling of Labeled Extracts:</title>
1061      <screenshot>
1062       <mediaobject>
1063        <imageobject>
1064         <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-tab-2-pool-labeledextract.png" format="PNG"/>
1065        </imageobject>
1066       </mediaobject>
1067      </screenshot>
1068     </figure>
1069    </listitem>
1070   </orderedlist>
1071  </sect2>
1072  <sect2 id="labeledextract.manage.delete">
1073   <title>Deleting/Restoring Labeled Extracts</title>
1074   <para>As for other items in BASE2, Labeled Extracts can be deleted. For a generic overview on how
1075    to delete and restore items, refer to section <xref linkend="webclient.items.delete"/></para>
1076   <para>To delete, do the following</para>
1077   <itemizedlist>
1078    <listitem>
1079     <para> Select one or more Labeled Extract and click &gbDelete; button in the
1080      menu bar. </para>
1081     <para> All the selected Labeled Extracts have been marked as deleted and are no longer
1082      available from the interface. </para>
1083     <para> Only by selecting from the <guilabel>view/preset&hellip;</guilabel> select box the
1084       <guilabel>Removed</guilabel> option, one can see those of the Labeled Extracts earmarked for
1085      deletion. They will be shown with a symbol in front of them. </para>
1086    </listitem>
1087    <listitem>
1088     <para> Alternately, navigating to the Labeled Extract Item View, one can hit the
1089       &gbDelete; to performed the task. As showed in the next picture, the
1090      Labeled Extract is then marked with the <inlinemediaobject>
1091       <imageobject>
1092        <imagedata fileref="figures/deleted.gif" format="GIF"/>
1093       </imageobject>
1094      </inlinemediaobject>
1095      <guiicon>This item has been flagged for deletion</guiicon>
1096     </para>
1097     <figure id="write_docbook_doc.figures.labeledextract-delete">
1098      <title>Deleting Labeled Extracts from the Item View</title>
1099      <screenshot>
1100       <mediaobject>
1101        <imageobject>
1102         <imagedata contentwidth="12cm" width="12cm" fileref="figures/labeledextract-delete.png" format="PNG"/>
1103        </imageobject>
1104       </mediaobject>
1105      </screenshot>
1106     </figure>
1107    </listitem>
1108    <listitem>
1109     <para>Deletion errors at this stage can be easily recovered. Select the item to recover from
1110      the List View (be sure to check the <guilabel>Removed</guilabel> option in the View/preset..
1111      filter) and hit the &gbRestore; to performed the task. </para>
1112    </listitem>
1113   </itemizedlist>
1114   <important>
1115    <para>To really delete an item from the database you must use the trashcan. Items deleted from
1116     the Trashcan can not be recovered. To learn more about the trashcan function, please refer to
1117      <xref linkend="trashcan"/>
1118    </para>
1119   </important>
1120  </sect2>
1121 </sect1>
1122 <sect1 id="hybridization.manage">
1123  <title>Managing Hybridizations</title>
1124  <para> An hybridization event corresponds to the application of one or more labeled extracts
1125   materials to a microarray slide under conditions detailed in hybridization protocols. </para>
1126  <para>In BASE2, there are 3 possible routes to create an hybridization object.</para>
1127  <sect2 id="hybridization.manage.create">
1128   <title>Creating Hybridizations</title>
1129   <orderedlist>
1130    <listitem>
1131     <para>Creating Hybridization from the Labeled Extract List View page</para>
1132     <para>Select at least one Labeled Extract by ticking to selection boxes before the name field.</para>
1133     <para>Click on the <guibutton>New hybridzation (to be changed)</guibutton> from the menu bar of
1134      Labeled Extract list view.</para>
1135     <figure id="write_docbook_doc.figures.hyb-create-labeledlistview">
1136      <title>Creating a Hybridization from the Labeled Extract List View</title>
1137      <screenshot>
1138       <mediaobject>
1139        <imageobject>
1140         <imagedata contentwidth="12cm" width="12cm" fileref="figures/hyb-create-labeledlistview.png" format="PNG"/>
1141        </imageobject>
1142       </mediaobject>
1143      </screenshot>
1144     </figure>
1145    </listitem>
1146    <listitem>
1147     <para>Creating Hybridization from the Labeled Extract Item View page</para>
1148     <para>After having selected a Labeled Extract and displayed it in the Item View, Click on the
1149       <guibutton>New hybridization</guibutton> button from the Menu bar of the Labeled Extract Item
1150      View.</para>
1151     <figure id="write_docbook_doc.figures.hyb-create-labeleditemview">
1152      <title>Creating a Hybridization from the Labeled Extract Item View</title>
1153      <screenshot>
1154       <mediaobject>
1155        <imageobject>
1156         <imagedata contentwidth="12cm" width="12cm" fileref="figures/hyb-create-labeleditemview.png" format="PNG"/>
1157        </imageobject>
1158       </mediaobject>
1159      </screenshot>
1160     </figure>
1161    </listitem>
1162    <listitem>
1163     <para>Creating Hybridizations from the Hybridization List View page</para>
1164     <para> Hybridizations can be created directly using the Hybridization create page. To do so, go
1165      to <menuchoice>
1166       <guimenu>View</guimenu>
1167       <guimenuitem>Hybridizations</guimenuitem>
1168      </menuchoice> , Click on &gbNew;
1169     </para>
1170     <figure id="write_docbook_doc.figures.hyb-create">
1171      <title>Creating Hybridizations from the Hybridization List View</title>
1172      <screenshot>
1173       <mediaobject>
1174        <imageobject>
1175         <imagedata contentwidth="12cm" width="12cm" fileref="figures/hyb-create.png" format="PNG"/>
1176        </imageobject>
1177       </mediaobject>
1178      </screenshot>
1179     </figure>
1180     <para> Irrespective of the methods chosen to create the Hybridization item, A 'Create' pop-up
1181      window will open. It contains 4 distinct tabs: <guilabel>Hybridization</guilabel>,
1182       <guilabel>Parents</guilabel>, <guilabel> Annotations &amp; parameters</guilabel> and
1183       <guilabel>Inherited Annotations</guilabel>. </para>
1184     <itemizedlist>
1185      <listitem>
1186       <para>The Hybridization Tab </para>
1187
1188       <variablelist>
1189        <varlistentry>
1190         <term>
1191          <interface>Name</interface>
1192         </term>
1193         <listitem>
1194          <para> New Hybridization is BASE2 default name but it is strongly advise to provide a
1195           meaningful and unique name as it matters for tab2mage export to function properly. </para>
1196          <para>There are 5 optional fields to provide more detailed information</para>
1197
1198         </listitem>
1199        </varlistentry>
1200
1201        <varlistentry>
1202         <term>
1203          <guilabel>Created</guilabel>
1204         </term>
1205         <listitem>
1206          <para>A date should be provided. The information can be important when running quality
1207           controls on data and account for potential confounding factor (e.g. to account for a day
1208           effect)</para>
1209         </listitem>
1210        </varlistentry>
1211
1212        <varlistentry>
1213         <term>
1214          <guilabel>Protocol</guilabel>
1215         </term>
1216         <listitem>
1217          <para>This is a controled field. A select-list displays protocol whose type is
1218            '<guilabel>hybridization</guilabel>' and which are shared to or owned by the logged-in
1219           user.</para>
1220          <important>
1221           <para> Reporting Protocols should be viewed as a MIAME requirement </para>
1222          </important>
1223         </listitem>
1224        </varlistentry>
1225
1226        <varlistentry>
1227         <term>
1228          <guilabel>Hardware</guilabel>
1229         </term>
1230         <listitem>
1231          <para>This is a controled field. A select-list displays Hardware whose type is
1232            '<guilabel>Hybridization station</guilabel>' and which are shared to or owned by the
1233           logged-in user.</para>
1234         </listitem>
1235        </varlistentry>
1236
1237        <varlistentry>
1238         <term>
1239          <guilabel>Array Slide</guilabel>
1240         </term>
1241         <listitem>
1242          <para>This is meant to specify the actual microarray slide.</para>
1243          <note>
1244           <para>Ideally, The Array Slides should have been created but for those users with
1245            permission to do, Array Slides could be generated at that point.</para>
1246          </note>
1247         </listitem>
1248        </varlistentry>
1249
1250        <varlistentry>
1251         <term>
1252          <guilabel>Description</guilabel>
1253         </term>
1254         <listitem>
1255          <para>A free text field to report any information that can not be captured
1256          otherwise</para>
1257         </listitem>
1258        </varlistentry>
1259
1260        <varlistentry>
1261         <term>
1262          <guilabel>Registered</guilabel>
1263         </term>
1264         <listitem>
1265          <para>This 7th field is automatically populated with a date at which the sample was
1266           entered in BASE2 system.</para>
1267         </listitem>
1268        </varlistentry>
1269       </variablelist>
1270
1271       <figure id="write_docbook_doc.figures.hybridization-tab-1">
1272        <title>Hybridization tab</title>
1273        <screenshot>
1274         <mediaobject>
1275          <imageobject>
1276           <imagedata contentwidth="12cm" width="12cm" fileref="figures/hybridization-tab-1.png" format="PNG"/>
1277          </imageobject>
1278         </mediaobject>
1279        </screenshot>
1280       </figure>
1281      </listitem>
1282      <listitem>
1283       <para>The Labeled Extract Tab </para>
1284       <para>This important tab allows users to select the Labeled Extracts applied to an Array
1285        Slide, and specify the amount of material used, expressed in microgram.</para>
1286       <figure id="write_docbook_doc.figures.hybridization-tab-2">
1287        <title>Labeled Extract tab</title>
1288        <screenshot>
1289         <mediaobject>
1290          <imageobject>
1291           <imagedata contentwidth="12cm" width="12cm" fileref="figures/hybridization-tab-2.png" format="PNG"/>
1292          </imageobject>
1293         </mediaobject>
1294        </screenshot>
1295       </figure>
1296      </listitem>
1297      <listitem>
1298       <para>Annotations &amp; parameters </para>
1299       <para>As seen in the BioSource and Sample sections, this tab allows users to supply further
1300        information about the hybridization provided annotation types have been defined or shared to
1301        annotate Hybridization items. The display of Annotation Types can be filtered based on the
1302        Annotation Type Category they belong to.</para>
1303       <important>
1304        <para> In order to use this feature, Annotation Type must be declared and made available. To
1305         learn more about Annotation Types, please refer to <xref linkend="annotations"/>
1306        </para>
1307       </important>
1308       <para>To provide a value for a given annotation type, simply click on it and use the input
1309        field or select a value from the drop-down lists or radio buttons.</para>
1310       <para>A caption also reminds users if Annotation Types are parameters <inlinemediaobject>
1311         <imageobject>
1312          <imagedata fileref="figures/parameter.gif" format="GIF"/>
1313         </imageobject>
1314        </inlinemediaobject>and if annotation values have already been supplied, marked by the <inlinemediaobject>
1315         <imageobject>
1316          <imagedata fileref="figures/annotated.gif" format="GIF"/>
1317         </imageobject>
1318        </inlinemediaobject> logo.</para>
1319       <figure id="write_docbook_doc.figures.hybridization-tab-3">
1320        <title>Annotations &amp; parameters</title>
1321        <screenshot>
1322         <mediaobject>
1323          <imageobject>
1324           <imagedata contentwidth="12cm" width="12cm" fileref="figures/hybridization-tab-3.png" format="PNG"/>
1325          </imageobject>
1326         </mediaobject>
1327        </screenshot>
1328       </figure>
1329      </listitem>
1330      <listitem>
1331       <para>Inherited Annotations </para>
1332       <para>The next screenshot shows a typical view of the functionality.</para>
1333       <figure id="write_docbook_doc.figures.hybridization-tab-4">
1334        <title>Inherited Annotations</title>
1335        <screenshot>
1336         <mediaobject>
1337          <imageobject>
1338           <imagedata contentwidth="12cm" width="12cm" fileref="figures/hybridization-tab-4.png" format="PNG"/>
1339          </imageobject>
1340         </mediaobject>
1341        </screenshot>
1342       </figure>
1343       <para> Note the tags used to distinguish between Annotation Types which are parameters noted <inlinemediaobject>
1344         <imageobject>
1345          <imagedata fileref="figures/parameter.gif" format="GIF"/>
1346         </imageobject>
1347        </inlinemediaobject> and those which are Biomaterial Characteristics,noted <inlinemediaobject>
1348         <imageobject>
1349          <imagedata fileref="figures/annotation.gif" format="GIF"/>
1350         </imageobject>
1351        </inlinemediaobject></para>
1352      </listitem>
1353     </itemizedlist>
1354    </listitem>
1355   </orderedlist>
1356  </sect2>
1357  <sect2 id="hybridization.manage.viewedit">
1358   <title>Viewing/Editing Hybridizations</title>
1359   <para>As for other items in BASE2, Hybridizations can be edited. To do so, do the following</para>
1360   <itemizedlist>
1361    <listitem>
1362     <para> Press and hold one of the <keycap>CTRL</keycap>, <keycap>ALT</keycap> or
1363      <keycap>SHIFT</keycap> keys while clicking on the name of an Hybridization Item, which is a
1364      live link. </para>
1365    </listitem>
1366    <listitem>
1367     <para> Alternately, navigating to the Hybridization Item View, one can hit the
1368      <guibutton>Edit</guibutton> to performed the task.</para>
1369    </listitem>
1370
1371    <listitem>
1372     <para>The Hybridization item View summarizes key information such as the list of
1373       <guilabel>Labeled Extracts</guilabel>, and the list of associated <guilabel>Scans</guilabel>.
1374      Both are available as hyperlinks to allow quick and easy navigation.</para>
1375     <figure id="write_docbook_doc.figures.hybridization-itemview">
1376      <title>Hardware Item View</title>
1377      <screenshot>
1378       <mediaobject>
1379        <imageobject>
1380         <imagedata contentwidth="10cm" width="10cm" fileref="figures/hybridization-itemview.png" format="PNG"/>
1381        </imageobject>
1382       </mediaobject>
1383      </screenshot>
1384     </figure>
1385    </listitem>
1386   </itemizedlist>
1387
1388  </sect2>
1389
1390  <sect2 id="hybridization.manage.delete">
1391   <title>Deleting/Restoring Hybridizations</title>
1392   <para>As for other items in BASE2, Hybridizations can be deleted. For a generic overview on how
1393    to delete and restore items, refer to section <xref linkend="webclient.items.delete"/>
1394   </para>
1395
1396   <para>To delete, do the following</para>
1397   <itemizedlist>
1398    <listitem>
1399     <para> Select one or more Hybridization Items and click on the &gbDelete;
1400      button in the menu bar. </para>
1401     <para> All the selected Hybridizations have been marked as deleted and are no longer available
1402      from the interface. </para>
1403     <para> Only by selecting from the <guilabel>view/preset&hellip;</guilabel> select box the
1404       <guilabel>Removed</guilabel> option, one can see those of the Hybridizations earmarked for
1405      deletion. They will be shown with a symbol in front of them. </para>
1406    </listitem>
1407    <listitem>
1408     <para> Alternately, navigating to the Hybridization Item View, one can hit the
1409       &gbDelete; to performed the task. As shown in the next picture, the
1410      Hybridization is then marked with the <inlinemediaobject>
1411       <imageobject>
1412        <imagedata fileref="figures/deleted.gif" format="GIF"/>
1413       </imageobject>
1414      </inlinemediaobject><guilabel>This item has been flagged for deletion</guilabel>
1415     </para>
1416     <figure id="write_docbook_doc.figures.hybridization-delete">
1417      <title>Deleting Hybridizations from the Hybridization Item View</title>
1418      <screenshot>
1419       <mediaobject>
1420        <imageobject>
1421         <imagedata contentwidth="10cm" width="10cm" fileref="figures/hybridization-delete.png" format="PNG"/>
1422        </imageobject>
1423       </mediaobject>
1424      </screenshot>
1425     </figure>
1426    </listitem>
1427   </itemizedlist>
1428   <important>
1429    <para>To really delete an item from the database you must use the trashcan. Items deleted from
1430     the Trashcan can not be recovered. To learn more about the trashcan function, please refer to
1431      <xref linkend="trashcan"/>
1432    </para>
1433   </important>
1434  </sect2>
1435 </sect1>
1436</chapter>
Note: See TracBrowser for help on using the repository browser.