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

Code
Comments
Other
Rev Date Author Line
360 28 Jul 07 dominic 1 Release Note: Tab2Mage Export Current Implementation
360 28 Jul 07 dominic 2 ----------------------------------------------------------------------------------------
360 28 Jul 07 dominic 3 ----------------------------------------------------------------------------------------
360 28 Jul 07 dominic 4 How do I define and configure the plugin
360 28 Jul 07 dominic 5 ---------------------------------------------------
360 28 Jul 07 dominic 6 Please note, to test the tab2mage plugin, you do not need to define and configure the plugin. It is automatically done for you. Once you have updated or installed Nutribase successfully proceed to the experiment page, select and click on an experiment and on the edit page, click on the export tab and follow subsequent instructions.
360 28 Jul 07 dominic 7
360 28 Jul 07 dominic 8 On the export GUI, you can save the file to be exported on the base2 file system using the browse button for the Save As field. This is a mandatory field.
360 28 Jul 07 dominic 9
360 28 Jul 07 dominic 10 Important Notice: Exported tab2mage file would be located on the base2 file system (in the location you have specified). This file can be downloaded to your desktop environment.  After download, please create an archive including the tab2mage export file and the associated raw data files, for onward submission to a repository like array express.
360 28 Jul 07 dominic 11
360 28 Jul 07 dominic 12 Experiment Section
360 28 Jul 07 dominic 13 -----------------------------
360 28 Jul 07 dominic 14   - Provides information about an experiment.
360 28 Jul 07 dominic 15 - The user must specify the release date for the experiment when initiating the tab2mage export.
360 28 Jul 07 dominic 16
360 28 Jul 07 dominic 17 Protocol Section
360 28 Jul 07 dominic 18 ------------------------
360 28 Jul 07 dominic 19 - This section displays all the protocols used within an experiment. The associated parameters are also displayed if any
360 28 Jul 07 dominic 20   - Protocol parameters are delimited with a semi colon.
360 28 Jul 07 dominic 21
360 28 Jul 07 dominic 22 Hybridization Section
360 28 Jul 07 dominic 23 -------------------------------
360 28 Jul 07 dominic 24 Hybridization - Protocol Section
360 28 Jul 07 dominic 25 ---------------------------------------------
360 28 Jul 07 dominic 26   - If  protocol has not been utilized in the experiment then
360 28 Jul 07 dominic 27     - no protocol id is displayed in the hybridization section.
360 28 Jul 07 dominic 28
360 28 Jul 07 dominic 29 Hybridization - BiomaterialXteristics
360 28 Jul 07 dominic 30 -------------------------------------------------
360 28 Jul 07 dominic 31 - These are all the xteristics and annotations of a biosource, excluding annotations of deleted annotation types or characteristics. 
360 28 Jul 07 dominic 32 - if a biosource exist i.e. has been used in an experiment , there might be biomaterial xteristics.
360 28 Jul 07 dominic 33 - if no biosource is used, then there would be no biomaterial xteristics in the export.
360 28 Jul 07 dominic 34
360 28 Jul 07 dominic 35 Hybridization - Experimental Factors
360 28 Jul 07 dominic 36 --------------------------------------------------
360 28 Jul 07 dominic 37 - 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 38 -  the default value for the experimental factor would be displayed, if it has been specified during the creation of  the linked annotation type.
360 28 Jul 07 dominic 39     
360 28 Jul 07 dominic 40 What is not supported
360 28 Jul 07 dominic 41 ----------------------------------
360 28 Jul 07 dominic 42 - Inherited annotations are not exported or supported for Protocol parameters in this current version.
360 28 Jul 07 dominic 43
360 28 Jul 07 dominic 44 - 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 this would then be supported.
360 28 Jul 07 dominic 45   
360 28 Jul 07 dominic 46 - Experiment Quality control - is not supported in base2, hence this will be missing in the tab2mage export at the experiment section
360 28 Jul 07 dominic 47
360 28 Jul 07 dominic 48 - Experiment publication’s pages, issues and volume are not supported. 
360 28 Jul 07 dominic 49
360 28 Jul 07 dominic 50 Controls:
360 28 Jul 07 dominic 51 --------------------
360 28 Jul 07 dominic 52 Export fails with a message, if:
360 28 Jul 07 dominic 53   - No bioassay is assigned to an experiment
360 28 Jul 07 dominic 54
360 28 Jul 07 dominic 55 - If the logged in user do not own the experiment or has no read permission on the experiment. 
360 28 Jul 07 dominic 56
360 28 Jul 07 dominic 57 - If experimental factors have not been specified for an experiment. 
360 28 Jul 07 dominic 58
360 28 Jul 07 dominic 59 - Also, 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.
360 28 Jul 07 dominic 60
360 28 Jul 07 dominic 61 -  Finally, if an array slide has not been provided for Hybridization 
360 28 Jul 07 dominic 62
360 28 Jul 07 dominic 63
360 28 Jul 07 dominic 64 /**
360 28 Jul 07 dominic 65 *This is a release note created for the tab2mage export *developed at the EBI for *Base2 and NutriBase. 
360 28 Jul 07 dominic 66 /*