extensions/no.uib.cbu.base.magetabexport/trunk/readme.txt

Code
Comments
Other
Rev Date Author Line
1476 29 Nov 11 pawels 1 MageTab Exporter Plug-in
1474 29 Nov 11 pawels 2 ---------------------------
1474 29 Nov 11 pawels 3
1476 29 Nov 11 pawels 4 From BASE2 experiment the plug-in exports the experimental metadata in MageTab format
1474 29 Nov 11 pawels 5
1474 29 Nov 11 pawels 6
1474 29 Nov 11 pawels 7 I Description
1474 29 Nov 11 pawels 8 ----------------
1476 29 Nov 11 pawels 9 Executed on an experiment in BASE2, the plug-in generates an SDRF and IDF files 
1474 29 Nov 11 pawels 10 (see MageTab specification at http://www.mged.org/mage-tab/) with experiment's metadata, 
1474 29 Nov 11 pawels 11 and an archive containing raw data files.
1474 29 Nov 11 pawels 12
1474 29 Nov 11 pawels 13
1474 29 Nov 11 pawels 14 II Requirements
1474 29 Nov 11 pawels 15 ----------------
1476 29 Nov 11 pawels 16 The plug-in was developed and tested with BASE 2.16.1. BASE 2.17.x versions should also be fine. 
1476 29 Nov 11 pawels 17 If you are able to use the plug-in with earlier versions of BASE, please let the developer know.
1474 29 Nov 11 pawels 18  
1474 29 Nov 11 pawels 19
1474 29 Nov 11 pawels 20 III Installation
1474 29 Nov 11 pawels 21 ----------------
1474 29 Nov 11 pawels 22   (1) Drop the jar in a folder in BASE (e.g. <BASE_HOME>/plugins).
1474 29 Nov 11 pawels 23   (2) Log in to BASE as a root, browse to Administrate -> Plugins -> Definitions, and click New.
1474 29 Nov 11 pawels 24   (3) In the dialog that opens, enter "no.uib.cbu.base.magetabexport.MageTabExporterPlugin" for class,
1476 29 Nov 11 pawels 25     and path to the plug-in jar file (e.g. <BASE_HOME>/plugins/MageTabExporter-x.x.jar) for path.
1476 29 Nov 11 pawels 26   (4) In the job agents tab, add job agents that will be able to execute the plug-in (if any).
1474 29 Nov 11 pawels 27   (5) Click Save
1474 29 Nov 11 pawels 28
1476 29 Nov 11 pawels 29   The new plug-in appears under the name "MageTab exporter" in the plug-ins list, and is now ready for use.
1474 29 Nov 11 pawels 30   
1474 29 Nov 11 pawels 31
1474 29 Nov 11 pawels 32 IV Usage  
1474 29 Nov 11 pawels 33 ----------------
1474 29 Nov 11 pawels 34
1476 29 Nov 11 pawels 35 The plug-in can be launched from the details page of an experiment. Please make sure that the experiment that is 
1474 29 Nov 11 pawels 36 to be exported is properly created (documented). Use the experiment overview/validation in BASE.
1474 29 Nov 11 pawels 37
1476 29 Nov 11 pawels 38 The plug-in supports pooled samples, extracts and labeled extracts, but currently the maximum level of 
1474 29 Nov 11 pawels 39 nesting of items of one type is 2. This means that pool of samples (and extracts/labeled extracts) is 
1474 29 Nov 11 pawels 40 supported, but pool of pooled samples (or extracts/labeled extracts) is not.
1474 29 Nov 11 pawels 41
1476 29 Nov 11 pawels 42 The MageTab exporter plug-in has following parameters:
1474 29 Nov 11 pawels 43   - Experiment 
1476 29 Nov 11 pawels 44     the experiment to export, set by default to the one that was open when launching the plug-in
1474 29 Nov 11 pawels 45   - Save as    
1474 29 Nov 11 pawels 46     a path and prefix for the files that are created, e.g. using /home/me/prefix will result
1476 29 Nov 11 pawels 47     in two files being created during the plug-in execution: /home/me/prefix_idf.txt and /home/me/prefix_sdrf.txt
1474 29 Nov 11 pawels 48   - Save raw data archive as
1474 29 Nov 11 pawels 49     name of the zip archive with raw data
1474 29 Nov 11 pawels 50   - Overwrite 
1474 29 Nov 11 pawels 51     if files with the same names as the ones specified in "Save as" and/or "Save raw data archive as"
1474 29 Nov 11 pawels 52     should be overwritten
1474 29 Nov 11 pawels 53   - Release date
1474 29 Nov 11 pawels 54     a date that is set in the IDF file as the Public Release Date
1474 29 Nov 11 pawels 55   - Quote fields
1474 29 Nov 11 pawels 56     if the content in tab-delimited IDF and SDRF files should be quoted with double quotes
1474 29 Nov 11 pawels 57   - Handle missing content by
1476 29 Nov 11 pawels 58     in certain experimental setups missing/empty content is allowed for biosources and/or samples. The plug-in 
1474 29 Nov 11 pawels 59     can ignore these missing content and fill empty values with a replacement text (see next parameter). 
1476 29 Nov 11 pawels 60     If you don't expect missing items in your experiment and set the parameter to Error, the plug-in will fail 
1474 29 Nov 11 pawels 61     with an error message if missing/empty item is found
1474 29 Nov 11 pawels 62   - Replace missing content with
1474 29 Nov 11 pawels 63     a text to replace missing items, e.g. "N/A", "-", ""
1474 29 Nov 11 pawels 64   - Raw data file type
1474 29 Nov 11 pawels 65     select the type of the raw data files that should be included in the raw data file archive. Options 
1474 29 Nov 11 pawels 66     available here are platform/variant specific
1474 29 Nov 11 pawels 67   - ArrayExpress accession AnnotationType
1474 29 Nov 11 pawels 68     type of annotations holding ArrayExpress accession ids (see (2) on section V to learn more)
1474 29 Nov 11 pawels 69   - Material Type AnnotationType
1474 29 Nov 11 pawels 70     type of annotations holding MGED ontology Material Type terms (see (3) in section V to learn more)
1474 29 Nov 11 pawels 71
1476 29 Nov 11 pawels 72 The MageTab exporter plug-in supports configuration, so site's default/preferred settings of many parameters can be stored 
1474 29 Nov 11 pawels 73 and reused to ease the execution.  
1474 29 Nov 11 pawels 74
1474 29 Nov 11 pawels 75
1474 29 Nov 11 pawels 76 V Useful tips
1474 29 Nov 11 pawels 77 ----------------
1474 29 Nov 11 pawels 78         
1476 29 Nov 11 pawels 79 To get most of the plug-in capabilities you could:
1476 29 Nov 11 pawels 80   (1) make sure that the format of the author and affiliation fields is parsable by the plug-in. 
1474 29 Nov 11 pawels 81   This will allow to split individual authors and automatically map them to institutions they are 
1474 29 Nov 11 pawels 82   affiliated with. Format the fields in the following way:
1474 29 Nov 11 pawels 83     - individual author entires should be split by ", " (comma + space)
1474 29 Nov 11 pawels 84     - author's names should be split by space, and in follow the order: first_name middle_name last_name
1474 29 Nov 11 pawels 85     - affiliation mark(s) should be numbers following the last name
1474 29 Nov 11 pawels 86     - between last name and affiliation mark(s) no spaces/characters is allowed
1474 29 Nov 11 pawels 87     - affiliation marks should be split by a single comma 
1474 29 Nov 11 pawels 88     Example: "John Jack Jones1,3 Joly Jane2, Jeremy Joe Jakes2,1,3"
1474 29 Nov 11 pawels 89     
1474 29 Nov 11 pawels 90     - individual institutions in affiliation field should be in separate lines (split by \n, \r or both) 
1474 29 Nov 11 pawels 91     - line number is the institution mark, e.g institution in line 3 will be mapped to authors with 
1474 29 Nov 11 pawels 92       affiliation mark 3.
1476 29 Nov 11 pawels 93     - if you put a number in front of the institution name it will help you check if the plug-in did
1474 29 Nov 11 pawels 94       a good job mapping authors with affiliations
1474 29 Nov 11 pawels 95     Example: "1 Institute Without a Name, Somestreet 100, 5044 Sometown, Somewhere
1474 29 Nov 11 pawels 96           2 Institute With a Name, Otherstreet 10, 1042 Othertown, Somewhereelse"
1474 29 Nov 11 pawels 97           
1474 29 Nov 11 pawels 98   The affiliation marks and the numbers preceding institutions are not removed, and will be present in the
1474 29 Nov 11 pawels 99   exported IDF file. This allows to check if the automatic mapping is correct. Afterwards, before the files are submitted
1474 29 Nov 11 pawels 100   to ArrayExpress, the numbers should be removed.  
1474 29 Nov 11 pawels 101   
1474 29 Nov 11 pawels 102   (2) create an annotation type representing an ArrayExpress accession identifier. The annotation type 
1474 29 Nov 11 pawels 103   should be enabled for array designs and protocols, and used to set accession ids on the items that 
1474 29 Nov 11 pawels 104   had been previously exported to ArrayExpress. If you export an experiment using a design or protocol(s) 
1476 29 Nov 11 pawels 105   with such an annotation, the plug-in will pick up identifiers from the annotations, and use them in 
1474 29 Nov 11 pawels 106   the exported SDRF file (Array Ref and Protocol Ref columns). Just remember to set the correct annotation
1476 29 Nov 11 pawels 107   type when you configure the plug-in ("ArrayExpress accession AnnotationType" parameter).
1474 29 Nov 11 pawels 108       
1474 29 Nov 11 pawels 109   (3) create an annotation type representing an MGED Ontology term: Material Type. The annotation type 
1474 29 Nov 11 pawels 110   should be enabled for biosources, samples, extracts and labeled extracts. If you then annotate your 
1476 29 Nov 11 pawels 111   biomaterials using this annotation type, and select it in the plug-in configuration parameter 
1476 29 Nov 11 pawels 112   ("Material Type AnnotationType"), the plug-in will use the annotations in the exported SDRF file 
1474 29 Nov 11 pawels 113   (Material Type column).
1474 29 Nov 11 pawels 114   
1476 29 Nov 11 pawels 115   (4) store some of the settings in a plug-in configuration. The annotation types are the best candidates. Also 
1474 29 Nov 11 pawels 116   raw data file types could be predefined in platform specific configurations.
1474 29 Nov 11 pawels 117   
1474 29 Nov 11 pawels 118     
1474 29 Nov 11 pawels 119
1474 29 Nov 11 pawels 120 License
1474 29 Nov 11 pawels 121 ----------------
1474 29 Nov 11 pawels 122 All rights reserved. This program and the accompanying materials
1474 29 Nov 11 pawels 123 are made available under the terms of the GNU Public License v3.0
1474 29 Nov 11 pawels 124 which accompanies this distribution, and is available at
1474 29 Nov 11 pawels 125 http://www.gnu.org/licenses/gpl-3.0.html
1474 29 Nov 11 pawels 126  

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