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

Code
Comments
Other
Rev Date Author Line
457 31 Oct 07 dominic 1 ===========================================================
373 08 Aug 07 dominic 2 Installation
373 08 Aug 07 dominic 3 ---------------
392 14 Aug 07 dominic 4
496 28 Nov 07 dominic 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. 
373 08 Aug 07 dominic 6   
496 28 Nov 07 dominic 7   - Install as new plugins uk.ac.ebi.nugo.plugins.Tab2MageImporter 
496 28 Nov 07 dominic 8   Note: If you get a class Loader error while installing the importer, you have two options:
496 28 Nov 07 dominic 9   
496 28 Nov 07 dominic 10   i) Upgrade to BASE 2.4.6  or
496 28 Nov 07 dominic 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.
496 28 Nov 07 dominic 12   
496 28 Nov 07 dominic 13   - If you have not already defined  and configured a working AnnotationTypeCvImporter.jar, then install as new plugin    uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter.
496 28 Nov 07 dominic 14   
373 08 Aug 07 dominic 15    1. In the BASE web client, go to Administrate -> Plugins -> Definitions.
373 08 Aug 07 dominic 16    2. Click New.
410 30 Aug 07 dominic 17    3. This will open up the 'Create plugin' pop-up window, 
410 30 Aug 07 dominic 18     for class:  enter " uk.ac.ebi.nugo.plugins.Tab2MageImporter".
410 30 Aug 07 dominic 19      for path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ Tab2MageImporter.jar 
410 30 Aug 07 dominic 20     if you have chosen another location for the jar, you should adapt to that.
410 30 Aug 07 dominic 21    4. Click the 'Save' button.
410 30 Aug 07 dominic 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).
410 30 Aug 07 dominic 23   6. Click New again
410 30 Aug 07 dominic 24   7. In the dialog that opens, 
373 08 Aug 07 dominic 25     for class enter " uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter".
496 28 Nov 07 dominic 26      for path enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/ AnnotationTypeCvImporter.jar
410 30 Aug 07 dominic 27     if you have chosen another location for the jar, you should adapt to that.
410 30 Aug 07 dominic 28    8. Click Save.
393 14 Aug 07 dominic 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. 
433 18 Sep 07 dominic 30   10. Proceed to configure the "AnnotationType and Cv Importer" plugin. 
433 18 Sep 07 dominic 31   An example import file is provided here: http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/sampleimportfile.txt
433 18 Sep 07 dominic 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
433 18 Sep 07 dominic 33   
410 30 Aug 07 dominic 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).
373 08 Aug 07 dominic 35
496 28 Nov 07 dominic 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
457 31 Oct 07 dominic 37
393 14 Aug 07 dominic 38   General Installation instruction is available at: http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
496 28 Nov 07 dominic 39  
373 08 Aug 07 dominic 40 ===========================================================
457 31 Oct 07 dominic 41  Use
457 31 Oct 07 dominic 42 =======
457 31 Oct 07 dominic 43 Warning:
496 28 Nov 07 dominic 44 -----------
457 31 Oct 07 dominic 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.
496 28 Nov 07 dominic 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).
457 31 Oct 07 dominic 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.
407 23 Aug 07 dominic 48
457 31 Oct 07 dominic 49   Permission
457 31 Oct 07 dominic 50   ----------------
496 28 Nov 07 dominic 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:
496 28 Nov 07 dominic 52   i.)  Edit the priviledge of the power user or user role in base. 
496 28 Nov 07 dominic 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.
402 17 Aug 07 dominic 54   
457 31 Oct 07 dominic 55   1. Platforms supported  are: Affymetrix, Agilent, Genepix 
496 28 Nov 07 dominic 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.
393 14 Aug 07 dominic 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.
457 31 Oct 07 dominic 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.
496 28 Nov 07 dominic 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
496 28 Nov 07 dominic 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.  
457 31 Oct 07 dominic 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.
373 08 Aug 07 dominic 62   6. Open the detail view of the newly created experiment and click on the import tab.
457 31 Oct 07 dominic 63    7. In the dialog that opens,  leave the settings for Plugin and File format on auto-detect and click Next.
393 14 Aug 07 dominic 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.
496 28 Nov 07 dominic 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.
496 28 Nov 07 dominic 66   10. Specficy a name for the directory to store unzipped files. This directory cannot be re-used on re-running the importer.
496 28 Nov 07 dominic 67   11. To run the importer in validation mode only, set 'Run validation' parameter to true  
496 28 Nov 07 dominic 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.
496 28 Nov 07 dominic 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.
373 08 Aug 07 dominic 70
457 31 Oct 07 dominic 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.
373 08 Aug 07 dominic 72

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