plugins/base2/uk.ac.ebi.tab2mage/trunk/Tab2MageExporter/README.txt

Code
Comments
Other
Rev Date Author Line
1188 11 Feb 10 jari 1 $Id$
1188 11 Feb 10 jari 2
360 28 Jul 07 dominic 3 Release Note: Tab2Mage Export Current Implementation
399 15 Aug 07 dominic 4 ==============================================
399 15 Aug 07 dominic 5 Installation
399 15 Aug 07 dominic 6 -----------------
366 02 Aug 07 dominic 7
501 28 Nov 07 dominic 8   - Place Tab2MageExporter.jar and ebi-plugins-utils.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server. 
399 15 Aug 07 dominic 9   - Install as new plugins uk.ac.ebi.nugo.plugins.Tab2MageExporter contained in $BASE_HOME/www/plugins/Tab2MageExporter.jar.
399 15 Aug 07 dominic 10   
490 28 Nov 07 dominic 11   Note: If you get a class Loader error while installing the exporter, you have two options:
490 28 Nov 07 dominic 12   
1188 11 Feb 10 jari 13   i) Upgrade to BASE 2.14.1  or
490 28 Nov 07 dominic 14   ii)  Place the two jar files: Tab2MageExporter.jar and ebi-plugins-utils.jar in your base installation classpath - i.e. : $BASE2_HOME/web-inf/lib, restart the tomcat server and proceed to install the plugin. In step (3) below, do not specify the plugin's path. Note that BASE do not recommend this approach but it's just a work around for a bug in base versions earlier than 2.4.6.
490 28 Nov 07 dominic 15   
399 15 Aug 07 dominic 16    1. In the BASE web client, go to Administrate -> Plugins -> Definitions.
399 15 Aug 07 dominic 17    2. Click New.
399 15 Aug 07 dominic 18    3. In the dialog that opens, 
399 15 Aug 07 dominic 19     for class enter " uk.ac.ebi.nugo.plugins.Tab2MageExporter".
399 15 Aug 07 dominic 20       for path enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ Tab2MageExporter.jar
399 15 Aug 07 dominic 21    4. Click Save.
399 15 Aug 07 dominic 22   The new plugins appears under the name "Tab2Mage Exporter"  in the plugins list and is now ready for use. 
399 15 Aug 07 dominic 23   
410 30 Aug 07 dominic 24     For other users to use the plugin as detailed in the next section, please share it to the appropriate users by manually setting the permissions on the plugin (sharing it to group 'Everyone' should be sufficient in most cases). 
399 15 Aug 07 dominic 25   
399 15 Aug 07 dominic 26   General Installation instruction is available at: http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
399 15 Aug 07 dominic 27 ==========================================================================================
399 15 Aug 07 dominic 28 Use
399 15 Aug 07 dominic 29 -------
399 15 Aug 07 dominic 30 Important Notice/ Warning: 
399 15 Aug 07 dominic 31 -----------------------------------
399 15 Aug 07 dominic 32   To use the tab2mage export plugin, you do not need to configure the plugin as it requires no configuration.
366 02 Aug 07 dominic 33
447 30 Oct 07 dominic 34   The exported tab2mage file would be located on the base2 file system (in the location you have specified). This file can thereafter be downloaded to your desktop   environment.  After the download, please create an archive including the tab2mage export file and the associated raw data files, for onward submission to a the Array Express repository.
366 02 Aug 07 dominic 35
447 30 Oct 07 dominic 36   It is advisable to verify that your experiment has all the required annotations and that it is Miame Complaint before running the   exporter.  To do this go to the Experiment   detail view page and click on the overview tab. 
366 02 Aug 07 dominic 37
399 15 Aug 07 dominic 38   The Tab2Mage export fails with a message, if:
399 15 Aug 07 dominic 39     - No bioassay is assigned to an experiment
399 15 Aug 07 dominic 40     - If the logged in user do not own the experiment or has no read permission on the experiment. 
399 15 Aug 07 dominic 41     - If experimental factors have not been specified for an experiment. 
447 30 Oct 07 dominic 42     - Also, note that if experimental factors (annotation type) for an experiment have been specified, and the annotation types are shared to Project. Do set the     Project active before exporting in Tab2mage otherwise export fails.
1188 11 Feb 10 jari 43     - Finally, if an array slide or array design has not been provided for Hybridization.
399 15 Aug 07 dominic 44
399 15 Aug 07 dominic 45   Besides, using the experiment overview functionality would help to prevent most of these failure points.
399 15 Aug 07 dominic 46
399 15 Aug 07 dominic 47 1. In the BASE web client, go to View -> Experiment
399 15 Aug 07 dominic 48 2. Go to the experiment detail view page.
399 15 Aug 07 dominic 49 3. Verify your experiment with the BASE experiment overview functionality as mentioned above
399 15 Aug 07 dominic 50 4. Click on the export tab and on the export GUI thats appears, the experiment has been configured as indicated by the black x.
399 15 Aug 07 dominic 51 5. The overwrite field has also been configured and set to false by default. Do change this to true if you want to overwrite an exisiting file.
399 15 Aug 07 dominic 52 6. Set the file path where the export file and it's name: (e.g. tab2mage.txt) should be saved on the base2 file system using the browse button for the Save As field. This is a mandatory field.
399 15 Aug 07 dominic 53 7.  Specify the date you would like the experiment to be made public or released by a public respository e.g. Array Express. and click Next
399 15 Aug 07 dominic 54 8. On the next screen click Finish and wait for the job to complete. You will be shown the progress of the Tab2mage export in the dialog, with the page refreshing itself regularly.
399 15 Aug 07 dominic 55
447 30 Oct 07 dominic 56 ==================================================================================
447 30 Oct 07 dominic 57   
447 30 Oct 07 dominic 58 What is not supported
447 30 Oct 07 dominic 59 ----------------------------------
447 30 Oct 07 dominic 60 - Inherited annotations are not exported or supported for Protocol parameters in this current version.
399 15 Aug 07 dominic 61
447 30 Oct 07 dominic 62 - Material Characteristics - not available in the current base2 release and therefore cannot be exported. This requires MGED entries. Ontologies and control vocabularies would be distributed with base2 in the nearest future and can then be supported.
447 30 Oct 07 dominic 63   
447 30 Oct 07 dominic 64 - Experiment Quality control - is not supported in base2, hence this will be missing in the tab2mage export at the experiment section
447 30 Oct 07 dominic 65
447 30 Oct 07 dominic 66 - Experiment publication’s pages, issues and volume are not supported. 
447 30 Oct 07 dominic 67
447 30 Oct 07 dominic 68
399 15 Aug 07 dominic 69 ====================================================================================================
366 02 Aug 07 dominic 70 Tab2Mage Sections
399 15 Aug 07 dominic 71 ----------------------------
360 28 Jul 07 dominic 72 Experiment Section
360 28 Jul 07 dominic 73 -----------------------------
399 15 Aug 07 dominic 74 - Provides information about an experiment.
360 28 Jul 07 dominic 75 - The user must specify the release date for the experiment when initiating the tab2mage export.
360 28 Jul 07 dominic 76
360 28 Jul 07 dominic 77 Protocol Section
360 28 Jul 07 dominic 78 ------------------------
360 28 Jul 07 dominic 79 - This section displays all the protocols used within an experiment. The associated parameters are also displayed if any
399 15 Aug 07 dominic 80 - Protocol parameters are delimited with a semi colon.
360 28 Jul 07 dominic 81
360 28 Jul 07 dominic 82 Hybridization Section
360 28 Jul 07 dominic 83 -------------------------------
360 28 Jul 07 dominic 84 Hybridization - Protocol Section
360 28 Jul 07 dominic 85 ---------------------------------------------
399 15 Aug 07 dominic 86 - If  protocol has not been utilized in the experiment then
399 15 Aug 07 dominic 87 - no protocol id is displayed in the hybridization section.
360 28 Jul 07 dominic 88
360 28 Jul 07 dominic 89 Hybridization - BiomaterialXteristics
360 28 Jul 07 dominic 90 -------------------------------------------------
360 28 Jul 07 dominic 91 - These are all the xteristics and annotations of a biosource, excluding annotations of deleted annotation types or characteristics. 
360 28 Jul 07 dominic 92 - if a biosource exist i.e. has been used in an experiment , there might be biomaterial xteristics.
360 28 Jul 07 dominic 93 - if no biosource is used, then there would be no biomaterial xteristics in the export.
360 28 Jul 07 dominic 94
360 28 Jul 07 dominic 95 Hybridization - Experimental Factors
360 28 Jul 07 dominic 96 --------------------------------------------------
360 28 Jul 07 dominic 97 - if experimental factors  have been declared for an experiment but has a null value (i.e. it’s value has not been specified).
360 28 Jul 07 dominic 98 -  the default value for the experimental factor would be displayed, if it has been specified during the creation of  the linked annotation type.
400 15 Aug 07 dominic 99
360 28 Jul 07 dominic 100
360 28 Jul 07 dominic 101
360 28 Jul 07 dominic 102 /**
399 15 Aug 07 dominic 103 *This is a release note created for the tab2mage export developed at the EBI for Base2 and NutriBase. 
360 28 Jul 07 dominic 104 /*

Generated on Tue Nov 21 03:44:36 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)