source: plugins/base2/uk.ac.ebi.tab2mage/trunk/Tab2MageImporter/README.txt

Last change on this file was 496, checked in by dominic, 14 years ago

updated read me file

  • Property svn:eol-style set to native
File size: 7.4 KB
Line 
1===========================================================
2Installation
3---------------
4
5  - Place Tab2MageImporter.jar, activation.jar, ebi-plugins-utils.jar, mail.jar, bloader.jar and AnnotationTypeCvImporter.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server.
6 
7  - Install as new plugins uk.ac.ebi.nugo.plugins.Tab2MageImporter
8  Note: If you get a class Loader error while installing the importer, you have two options:
9 
10  i) Upgrade to BASE 2.4.6  or
11  ii) Place all the jar files above 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.
12 
13  - If you have not already defined  and configured a working AnnotationTypeCvImporter.jar, then install as new plugin    uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter.
14 
15  1. In the BASE web client, go to Administrate -> Plugins -> Definitions.
16  2. Click New.
17  3. This will open up the 'Create plugin' pop-up window,
18    for class:  enter " uk.ac.ebi.nugo.plugins.Tab2MageImporter".
19    for path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ Tab2MageImporter.jar
20    if you have chosen another location for the jar, you should adapt to that.
21  4. Click the 'Save' button.
22  5. Share the plug-in to all users/roles/groups that should have access to it (sharing it to group 'Everyone' should be sufficient in most cases).
23  6. Click New again
24  7. In the dialog that opens,
25    for class enter " uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter".
26    for path enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ AnnotationTypeCvImporter.jar
27    if you have chosen another location for the jar, you should adapt to that.
28  8. Click Save.
29  The new plugins appears under the name "Tab2Mage Importer" and "AnnotationType and Cv Importer" respectively in the plugins list and are now ready for use.
30  10. Proceed to configure the "AnnotationType and Cv Importer" plugin.
31  An example import file is provided here: http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/sampleimportfile.txt
32  An example configuration file that can be imported into base is provided here:  http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/annotationtypecvimporter.xml
33 
34  11. For other users to use the plugin as detailed in the next section, please share them to the appropriate users by manually setting the permissions on the item. (sharing it to group 'Everyone' should be sufficient in most cases).
35
36  12. PERMISSION for users and/or the tab2mage importer plugin is important to run an import successfully. Please check the WARNING in the 'USE' section below
37
38  General Installation instruction is available at: http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
39 
40===========================================================
41 Use
42=======
43Warning:
44-----------
45  --  User with a specified quota must have the required capacity to store files and create base items. Note that user can have unlimited quota.
46  --  Note that in its current implementation, only one RawDataImporter plugin configuration can be used during the import process. This means that raw data files must be consistent throughout. (this might be an issue when using different scanner versions).
47  --  The importer can be executed in a validation mode, to first validate the tab2mage spreadsheet before loading in to BASE. Please see the instructions on the GUI   when running the plugin for guidance.
48
49  Permission
50  ----------------
51  --  Make sure that the user running Tab2Mage Importer plugin has enough permission to do so. With the default Roles settings in BASE, User and PowerUser roles have not enough permission to run the plugin successfully. There are two options available:
52  i.)  Edit the priviledge of the power user or user role in base.
53  ii.) Assign permissions to the Tab2Mage Importer Plugin. The plugin does not use permission by default, but the administrator can set permission for the plugin. Please see :http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.permissions.html for setting plugin permissions.
54 
55  1. Platforms supported  are: Affymetrix, Agilent, Genepix
56  2. Create all the array design used in the experiment as the BASE administrator. Array Design must then be shared to everyone or a suitable group that all the target users belong.
57  3. Create tab2mage spreadsheet and zip it together with the raw data files  that make up the experiment. Note: no cdf file. Upload this file to your account on BASE (go to View -> Files -> Upload File). Image files may be supplied by the user and contained in the zip file.
58  Note: To avoid the laborious process of checking and formatting your tab2mage spreadsheet. Please use the example files: tab2mage- agilent, tab2mage- genepix and tab2mage- affymetrix, provided with the distribution as the spreadsheet template. For instance, the protocol section of your spreadsheet must have the protocol type specified.If not the plugin will fail. Running the import in validation mode will help identify all potential problems.
59  - For more information see the spreadsheet rules available here: .http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/Tab2MageImporter/tab2mage-spreadsheet-rules.txt
60  4. To ensure you have all the required reporters and import configurations in place, import a single data file from the batch as a test first. 
61  5. If the previous step was successful, create a new experiment  and specify the raw data type ( remember only affymetrix, genepix and agilent  platforms are supported) . Ensure that  the experiment is of the same data type as the data in the files you want to import. Click the import tab from the plugin menu, select Tab2Mage Importer and click Next.
62  6. Open the detail view of the newly created experiment and click on the import tab.
63  7. In the dialog that opens,  leave the settings for Plugin and File format on auto-detect and click Next.
64  8 On the next screen, Select the batch file that contains the raw data files, the Tab2Mage text file and the image file if supplied  and  click Next.
65  9. On the next screen, the ZipFile and Experiment parameters should already be configured now (as indicated by the black cross against them). Enter the name of your Tab2Mage file as a value for the "Tab2Mage FileName with Extension" parameter.  Specify  your email server if you want to receive notification on the success or failure of your experiment loading.
66  10. Specficy a name for the directory to store unzipped files. This directory cannot be re-used on re-running the importer.
67  11. To run the importer in validation mode only, set 'Run validation' parameter to true 
68  12.  If you wish, you can change the default filename for the "Save Validation Report As" parameter. If the validation report already exists indicate whether it should overwritten with the "overwrite" parameter.and click Next.
69  13. On the next screen click Finish and wait for the job to complete. You will be shown the progress of the Tab2mage import in the dialog, with the page refreshing itself regularly.
70
71  When the import has finished, you can check and review the uploaded experiment by navigating through base2 web client, using the menu. If you have provided your email server name. You would receive an email message on the status of the import.
72
Note: See TracBrowser for help on using the repository browser.