source: trunk/uk/ac/ebi/Tab2MageImporter/README.txt @ 457

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

commit file for the latest version of the tab2mage importer

  • Property svn:eol-style set to native
File size: 8.8 KB
Line 
1===========================================================
2Installation
3---------------
4
5  - Place Tab2MageImporter.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server.
6  - Install as new plugins uk.ac.ebi.nugo.plugins.Tab2MageImporter and uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter which are both contained in $BASE_HOME/www/plugins/Tab2MageImporter.jar.
7 
8  1. In the BASE web client, go to Administrate -> Plugins -> Definitions.
9  2. Click New.
10  3. This will open up the 'Create plugin' pop-up window,
11    for class:  enter " uk.ac.ebi.nugo.plugins.Tab2MageImporter".
12    for path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ Tab2MageImporter.jar
13    if you have chosen another location for the jar, you should adapt to that.
14  4. Click the 'Save' button.
15  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).
16  6. Click New again
17  7. In the dialog that opens,
18    for class enter " uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter".
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  8. Click Save.
22  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.
23  10. Proceed to configure the "AnnotationType and Cv Importer" plugin.
24  An example import file is provided here: http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/sampleimportfile.txt
25  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
26 
27  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).
28
29  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
30
31  General Installation instruction is available at: http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
32   
33===========================================================
34 Use
35=======
36Warning:
37----
38  --  User with a specified quota must have the required capacity to store files and create base items. Note that user can have unlimited quota.
39  --  Re- running the import plugin without having deleted the previously created directory from the zip file will make the Importer fail. Please delete from the trash can too.
40  --  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).
41  --  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.
42
43  Permission
44  ----------------
45  --  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:
46  i.  Edit the priviledge of the power user or user role in base.
47  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.
48 
49  1. Platforms supported  are: Affymetrix, Agilent, Genepix
50  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.
51  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.
52  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.
53  4. To make sure you have all the required reporters and import configurations in place, import a single data file from the batch as a test first. 
54  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.
55  6. Open the detail view of the newly created experiment and click on the import tab.
56  7. In the dialog that opens,  leave the settings for Plugin and File format on auto-detect and click Next.
57  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.
58  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.
59  10. 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.
60  11. To run the importer in validation mode only, set 'Run validation' parameter to true and click Next.
61  12. 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.
62
63  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.
64
65 ===========================================================
66AnnotationTypes and Cv Importer
67----------------------------------------------
68  --the annotation type and cv loader plugin; uk.ac.ebi. nugo.plugins.CvAnnotationTypeImporter must be defined and configured. Both the plugin and it's configured object must be shared to the user running the Tab2MageImporter.  Defining and configuring the plugin should be done preferably by the administrator. The administrator should share the configuration to the users as well. Otherwise suitable plugin configurations cannot be found and the import would fail.
69  --A naming comparism of the annotation type in the flat file to the annotation type in base2 is actualized. Only non-existing annotation types are created.
70
71===============================================================
72Limitations and Known Issues
73----------------------------------
74i. Only one raw data importer plugin configuration can be used at any one time during an experiment import.
75This means that all raw  data files in a tab2mage.zip archive should have the same data header. For Raw datafile from Genepix (or .gpr files) and Agilent, there is a certain level of polymorphism that may occur should scanner models used in a experiment run different versions of the software. Users will have to harmonize the files to one layout in order to upload the Experiment in BASE2 using the current plugin.
76
77===============================================================
78Email alert:
79---------------
80To receive an email alert on the success or failure of your experiment loading,
81
82Windows users:
83---------------------
84  Your antivirus server and anti spam software may prevent you from sending email messages. This is because they must have been configured to block all application requiring connection to your email sever on port 25 (smtp).
85  If this happens, you can simply ask your administrator to allow your machine to connect to the email server using port 25.
86
87  The email alert works on a linux / unix and may be mac machines.
88==============================================================
Note: See TracBrowser for help on using the repository browser.