doc/src/docbook/user/overview.xml

Code
Comments
Other
Rev Date Author Line
3766 21 Sep 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3766 21 Sep 07 martin 2 <!DOCTYPE chapter PUBLIC 
3766 21 Sep 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3766 21 Sep 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
4484 08 Sep 08 jari 5 <!--
4484 08 Sep 08 jari 6   $Id$
4484 08 Sep 08 jari 7   
4484 08 Sep 08 jari 8   Copyright (C) 2007 Nicklas Nordborg, Martin
4484 08 Sep 08 jari 9   
4484 08 Sep 08 jari 10   This file is part of BASE - BioArray Software Environment.
4484 08 Sep 08 jari 11   Available at http://base.thep.lu.se/
4484 08 Sep 08 jari 12   
4484 08 Sep 08 jari 13   BASE is free software; you can redistribute it and/or
4484 08 Sep 08 jari 14   modify it under the terms of the GNU General Public License
4484 08 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
4484 08 Sep 08 jari 16   of the License, or (at your option) any later version.
4484 08 Sep 08 jari 17   
4484 08 Sep 08 jari 18   BASE is distributed in the hope that it will be useful,
4484 08 Sep 08 jari 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
4484 08 Sep 08 jari 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4484 08 Sep 08 jari 21   GNU General Public License for more details.
4484 08 Sep 08 jari 22   
4484 08 Sep 08 jari 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/>.
4484 08 Sep 08 jari 25 -->
4484 08 Sep 08 jari 26
3794 27 Sep 07 nicklas 27 <chapter id="userdoc_overview" chunked="0">
5782 04 Oct 11 nicklas 28   <?dbhtml filename="overview.html" ?>
5782 04 Oct 11 nicklas 29
3766 21 Sep 07 martin 30   <title>Overview of user documentation</title>
4487 08 Sep 08 jari 31   <para> The 'User documentation' part is quite extensive and covers everything from how to Log in on
4487 08 Sep 08 jari 32     a BASE server and find your way through the program, to working with experiments and doing some
4395 15 Aug 08 martin 33     useful analysis. The intention with this chapter is to give an overview of the following chapters
4395 15 Aug 08 martin 34     so it will be easier for you to know where to look for certain information in case you don't want
4395 15 Aug 08 martin 35     to read the whole part from the beginning to the end.</para>
3782 25 Sep 07 martin 36   <sect1 id="userdoc_overview.environment">
3782 25 Sep 07 martin 37     <title>Working environment</title>
4395 15 Aug 08 martin 38     <para> Before you start working with any big experiment or project in BASE it could be a good idea
4395 15 Aug 08 martin 39       to get to know the environment and perhaps personalize some behavior and appearance of the
4395 15 Aug 08 martin 40       program. When this is done your daily work in BASE will be much easier and you will feel more
4395 15 Aug 08 martin 41       comfortable working with the program.</para>
3766 21 Sep 07 martin 42     <para>
4395 15 Aug 08 martin 43       Most of the things that have to do with the working environment are gathered in one chapter,
4395 15 Aug 08 martin 44       where the first subsection,
4395 15 Aug 08 martin 45       <xref linkend="webclient.introduction" />
4395 15 Aug 08 martin 46       , gives a good guidance how to start using BASE including a general explanation how to navigate
4395 15 Aug 08 martin 47       your way through the program.
3766 21 Sep 07 martin 48     </para>
3782 25 Sep 07 martin 49     <para>
3782 25 Sep 07 martin 50       The second subsection,
4395 15 Aug 08 martin 51       <xref linkend="webclient.configuration" />
4487 08 Sep 08 jari 52       , describes how to personalize BASE with contact information, preferences and changing password.
4395 15 Aug 08 martin 53       The preferences are for instance some appearance like date format, text size or the look of the
4395 15 Aug 08 martin 54       toolbar buttons.
3782 25 Sep 07 martin 55     </para>
3782 25 Sep 07 martin 56     <para>
3790 26 Sep 07 martin 57       The last two subsections,
3790 26 Sep 07 martin 58       <xref linkend="webclient.items" />
3790 26 Sep 07 martin 59       and
4395 15 Aug 08 martin 60       <xref linkend="webclient.itemlist" />
4487 08 Sep 08 jari 61       , in the web client chapter explains how to work with BASE. No matter what you are going to do the
4395 15 Aug 08 martin 62       user interface contains a lot of common functions that works the same everywhere. For example,
4395 15 Aug 08 martin 63       how to list and search for items, how to create new items and modify and delete existing items.
4395 15 Aug 08 martin 64       Subsequent chapters with detailed information about each type of item will usually not include
4395 15 Aug 08 martin 65       descriptions of the common functionality.
3782 25 Sep 07 martin 66     </para>
3782 25 Sep 07 martin 67   </sect1>
3892 30 Oct 07 nicklas 68   <sect1 id="userdoc_overview.start2work">
3892 30 Oct 07 nicklas 69     <title>Start working with BASE</title>
3782 25 Sep 07 martin 70     <para>
4395 15 Aug 08 martin 71       There are some working principles that need to be understood by all users in BASE. These concern
4395 15 Aug 08 martin 72       the permission system and how to get the workflow to move on without any disturbance caused by
4395 15 Aug 08 martin 73       insufficient permissions. The key is to work in projects, which is covered in detail in
4395 15 Aug 08 martin 74       <xref linkend="project_permission" />
4395 15 Aug 08 martin 75       .
3782 25 Sep 07 martin 76     </para>
4395 15 Aug 08 martin 77     <para> 
4395 15 Aug 08 martin 78       Understanding the permission system and how to work in projects will not only make it more
4395 15 Aug 08 martin 79       simple for you to work in BASE but also for your co-workers who want access to your data.
3782 25 Sep 07 martin 80     </para>
3782 25 Sep 07 martin 81     <para>
4395 15 Aug 08 martin 82       The next thing to do is to add some relevant data to work with. Most of the different items can
4395 15 Aug 08 martin 83       be created manually from the web client, but some items and data must be imported from files.
4487 08 Sep 08 jari 84       Before importing a file, it has to be uploaded on the BASE-server's file system.
3782 25 Sep 07 martin 85       <xref linkend="file_system" />
3790 26 Sep 07 martin 86       gives you information about the server's file system and how to upload the files.
3782 25 Sep 07 martin 87     </para>
3790 26 Sep 07 martin 88     <para>
4432 01 Sep 08 jari 89       <xref linkend="import_data" /> explains how the import is done
4432 01 Sep 08 jari 90       and <xref linkend="export_data" /> covers how data later on can
4432 01 Sep 08 jari 91       be exported from the database back into files, often simple text
4432 01 Sep 08 jari 92       files or xml files.
3790 26 Sep 07 martin 93     </para>
4395 15 Aug 08 martin 94     <para> 
4395 15 Aug 08 martin 95       Each different item has it's own section in this part of the documentation, where more
4395 15 Aug 08 martin 96       specific information and also some screen shots can be found. Go back to the table of contents
4395 15 Aug 08 martin 97       for this part and look up the item you want to know more about.
4395 15 Aug 08 martin 98     </para>
3766 21 Sep 07 martin 99     
4395 15 Aug 08 martin 100     
5684 02 Aug 11 nicklas 101     <sect2 id="userdoc_overview.start2work.administrative">
5684 02 Aug 11 nicklas 102       <title>Administrative tasks</title>
4395 15 Aug 08 martin 103         <para> 
4395 15 Aug 08 martin 104           Most of the tasks in this section require more privileges than the normal user
4395 15 Aug 08 martin 105           credentials. As always, there are many ways to do things so steps presented here is the path
4395 15 Aug 08 martin 106           to get going with BASE as fast as possible without creating havoc in future use of the BASE
4395 15 Aug 08 martin 107           server.
4395 15 Aug 08 martin 108         </para>
4395 15 Aug 08 martin 109         <orderedlist>
4395 15 Aug 08 martin 110           <listitem>
4395 15 Aug 08 martin 111             <para>
4395 15 Aug 08 martin 112               Log in as
4395 15 Aug 08 martin 113               <prompt>root</prompt>
4395 15 Aug 08 martin 114               using the password you set during BASE initialization. Create an account and give it the
4395 15 Aug 08 martin 115               administrator-role. Switch user to the new admin account and use this for all future
4395 15 Aug 08 martin 116               administrative tasks.
4395 15 Aug 08 martin 117             </para>
4395 15 Aug 08 martin 118             <note>
4395 15 Aug 08 martin 119               <para> 
4395 15 Aug 08 martin 120                 The root-account should only be used to create the first administrator account and
4395 15 Aug 08 martin 121                 nothing else.
4395 15 Aug 08 martin 122               </para>
4395 15 Aug 08 martin 123             </note>
4395 15 Aug 08 martin 124           </listitem>
4395 15 Aug 08 martin 125           <listitem>
4395 15 Aug 08 martin 126             <para> 
4395 15 Aug 08 martin 127               First thing to do, when logged in as administrator, is to create other user-accounts
4395 15 Aug 08 martin 128               and give them appropriate roles, most of them should be assigned to the User-role.
4395 15 Aug 08 martin 129             </para>
4395 15 Aug 08 martin 130             <para>
4395 15 Aug 08 martin 131               Information related to user-accounts can be found at
5738 15 Sep 11 nicklas 132               <xref linkend="accounts" />.
4395 15 Aug 08 martin 133             </para>
4395 15 Aug 08 martin 134           </listitem>
4395 15 Aug 08 martin 135           <listitem>
4395 15 Aug 08 martin 136             <para>
4395 15 Aug 08 martin 137               Next step for you as an administrator is to import reporter-map and corresponding reporters
4395 15 Aug 08 martin 138               to BASE. For import of Genepix data you can use the
4395 15 Aug 08 martin 139               <prompt>Reporter importer</prompt>
4395 15 Aug 08 martin 140               plug-in and
4395 15 Aug 08 martin 141               <prompt>Reporter map importer</prompt>
4395 15 Aug 08 martin 142               plug-in that come with BASE. Go to
4395 15 Aug 08 martin 143               <menuchoice>
5971 17 Feb 12 nicklas 144                 <guimenu>Array LIMS</guimenu>
4395 15 Aug 08 martin 145                 <guimenuitem>Array designs</guimenuitem>
4395 15 Aug 08 martin 146               </menuchoice>
4395 15 Aug 08 martin 147               or
4395 15 Aug 08 martin 148               <menuchoice>
5971 17 Feb 12 nicklas 149                 <guimenu>View</guimenu>
4395 15 Aug 08 martin 150                 <guimenuitem>Reporters</guimenuitem>
4395 15 Aug 08 martin 151               </menuchoice>
4395 15 Aug 08 martin 152               respectively and start the import from there. You can read more about data-import in
4432 01 Sep 08 jari 153               <xref linkend="import_data" />
4395 15 Aug 08 martin 154             </para>
4395 15 Aug 08 martin 155           </listitem>
4395 15 Aug 08 martin 156         </orderedlist>
5684 02 Aug 11 nicklas 157       </sect2>
5684 02 Aug 11 nicklas 158       <sect2 id="userdoc_overview.start2work.user">
4395 15 Aug 08 martin 159         <title>User tasks</title>
4395 15 Aug 08 martin 160         <para> 
4395 15 Aug 08 martin 161           A normal user is not allowed to add array design, reporter information, and a lot of
4395 15 Aug 08 martin 162           other information to BASE. The reason for this is that a lot of information should only exist
4395 15 Aug 08 martin 163           as one copy in the database. For example, reporters should only exist in one copy because
4395 15 Aug 08 martin 164           everyone uses the same reporters. There is no need to store several copies of the same array
4395 15 Aug 08 martin 165           design.
4395 15 Aug 08 martin 166         </para>
4395 15 Aug 08 martin 167         <para> 
4395 15 Aug 08 martin 168           A user will normally upload experimental data to BASE for import into the database. To be
4395 15 Aug 08 martin 169           able to import the data, the array design which is used, must be available in BASE at import
4395 15 Aug 08 martin 170           time. If the array design is not available, a user with the proper credential must add the
4395 15 Aug 08 martin 171           array design to BASE.
4395 15 Aug 08 martin 172         </para>
4395 15 Aug 08 martin 173         <orderedlist>
4395 15 Aug 08 martin 174           <listitem>
4395 15 Aug 08 martin 175             <para>
4395 15 Aug 08 martin 176               The first thing for an user to do is creating a project to work in and set this as
5684 02 Aug 11 nicklas 177               <emphasis>the active project</emphasis>.
5684 02 Aug 11 nicklas 178               This should be done before any other items are created.
4395 15 Aug 08 martin 179               <xref linkend="project_permission.projects" />
5684 02 Aug 11 nicklas 180               tell you more about how working in projects can help you and your co-workers.
4395 15 Aug 08 martin 181             </para>
4395 15 Aug 08 martin 182           </listitem>
4395 15 Aug 08 martin 183           <listitem>
4395 15 Aug 08 martin 184             <para>
4395 15 Aug 08 martin 185               Next step is to create raw bioassays and up-load raw data to BASE. This is done in the raw
5789 06 Oct 11 nicklas 186               bioassay section. (<menuchoice>
5971 17 Feb 12 nicklas 187                 <guimenu>View</guimenu>
4395 15 Aug 08 martin 188                 <guimenuitem>Raw bioassays</guimenuitem>
5789 06 Oct 11 nicklas 189               </menuchoice>) . For more information see
5789 06 Oct 11 nicklas 190               <xref linkend="experiments_analysis.rawbioassay" />.
4395 15 Aug 08 martin 191             </para>
4395 15 Aug 08 martin 192           </listitem>
4395 15 Aug 08 martin 193           <listitem>
4395 15 Aug 08 martin 194             <para>
4395 15 Aug 08 martin 195               Now when there are data to work with, you can create your first experiment. You reach the
4395 15 Aug 08 martin 196               experiment section through the menu
4395 15 Aug 08 martin 197               <menuchoice>
5971 17 Feb 12 nicklas 198                 <guimenu>View</guimenu>
4395 15 Aug 08 martin 199                 <guimenuitem>Experiments</guimenuitem>
5789 06 Oct 11 nicklas 200               </menuchoice>.
4395 15 Aug 08 martin 201               Further reading in
5789 06 Oct 11 nicklas 202               <xref linkend="experiments_analysis.experiments" />.
4395 15 Aug 08 martin 203             </para>
4395 15 Aug 08 martin 204           </listitem>
4395 15 Aug 08 martin 205           <listitem>
4395 15 Aug 08 martin 206             <orderedlist>
4395 15 Aug 08 martin 207               <listitem>
4395 15 Aug 08 martin 208                 <para>
4395 15 Aug 08 martin 209                   The analysis often starts with the creation of a root bioassay set. Open the recently
4395 15 Aug 08 martin 210                   created experiment and go to the
4395 15 Aug 08 martin 211                   <guilabel>Bioassay sets</guilabel>
4395 15 Aug 08 martin 212                   tab. Click on the
4395 15 Aug 08 martin 213                   <guibutton>New root bioassay set</guibutton>
4395 15 Aug 08 martin 214                   button to start the creation.
4395 15 Aug 08 martin 215                 </para>
4395 15 Aug 08 martin 216               </listitem>
4395 15 Aug 08 martin 217               <listitem>
4395 15 Aug 08 martin 218                 <para>
4395 15 Aug 08 martin 219                   With a root bioassay set you can now continue your analysis with different kinds of
4395 15 Aug 08 martin 220                   analysis plug-in. To the right of the each listed bioassay set is a set of icons for the
4395 15 Aug 08 martin 221                   actions that can be performed.
4395 15 Aug 08 martin 222                   <xref linkend="experiments_analysis.analysis" />
4395 15 Aug 08 martin 223                   goes to the bottom of analysis in BASE.
4395 15 Aug 08 martin 224                 </para>
4395 15 Aug 08 martin 225               </listitem>
4395 15 Aug 08 martin 226             </orderedlist>
4395 15 Aug 08 martin 227           </listitem>
4395 15 Aug 08 martin 228         </orderedlist>
4395 15 Aug 08 martin 229         <para> 
4487 08 Sep 08 jari 230           This concludes the short step-by-step get going text. Far from all functionality in BASE
4487 08 Sep 08 jari 231           has been covered here. E.g. nothing about LIMS or biomaterials have been mentioned. But you
4395 15 Aug 08 martin 232           should now at least be familiar with getting to that point when it is possible to do some
4395 15 Aug 08 martin 233           analysis.
4395 15 Aug 08 martin 234         </para>
4395 15 Aug 08 martin 235     </sect2>
3782 25 Sep 07 martin 236   </sect1>
4432 01 Sep 08 jari 237 </chapter>

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