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

Code
Comments
Other
Rev Date Author Line
401 16 Aug 07 dominic 1 Release Note of Affymetrix Array Design Batch Importer
401 16 Aug 07 dominic 2 ============================================================
401 16 Aug 07 dominic 3 General Information:
401 16 Aug 07 dominic 4 ---------------------
401 16 Aug 07 dominic 5
401 16 Aug 07 dominic 6 This plugin imports array designs for affymetrix - single channel- array design only. The entry point for this plugin in base 2 is the Array Design list page. Array LIMS->Array Designs. The array designs must be provided in a zip archive. The plugins will do the unpacking, creates the array designs using the array design file name and also attach the cdf, clf or bpmap file to the newly created array design. If an array design already exists, the plug-in skips the cdf, bpmap or clf file. Please note that only a user with an administrator role may execute this plugin.
401 16 Aug 07 dominic 7
401 16 Aug 07 dominic 8 ========================================================================================================
401 16 Aug 07 dominic 9
401 16 Aug 07 dominic 10 To Install the plugin:
401 16 Aug 07 dominic 11 ----------------------
503 28 Nov 07 dominic 12   - Place AffyArrayDesignBatchImporter.jar and ebi-plugins-utils.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server. 
410 30 Aug 07 dominic 13   - Install as new plugins uk.ac.ebi.nugo.plugins.AffyArrayDesignBatchImporter.jar contained in  $BASE_HOME/www/plugins/AffyArrayDesignBatchImporter.jar  .
401 16 Aug 07 dominic 14   
410 30 Aug 07 dominic 15    1. Log in to BASE with plug-in administrative privileges, 
410 30 Aug 07 dominic 16   2. In the BASE web client, go to Administrate->Plugins->Definition
410 30 Aug 07 dominic 17   3. Click New to define the plugin. 
410 30 Aug 07 dominic 18   4. Set the class and path parameters, in the dialog that opens
401 16 Aug 07 dominic 19     Class: uk.ac.ebi.nugo.plugins.AffyArrayDesignBatchImporter.jar
401 16 Aug 07 dominic 20     Path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/AffyArrayDesignBatchImporter.jar 
410 30 Aug 07 dominic 21   5. Click Save
401 16 Aug 07 dominic 22   The new plugins appears under the name "Affymetrix Array Design Batch Importer" in the plugins list and is now ready for use. 
401 16 Aug 07 dominic 23
401 16 Aug 07 dominic 24   General Installation instruction is available at:  
401 16 Aug 07 dominic 25 http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
401 16 Aug 07 dominic 26
401 16 Aug 07 dominic 27 ===============================================================================================
401 16 Aug 07 dominic 28 To use the plugin:
401 16 Aug 07 dominic 29 --------------------
401 16 Aug 07 dominic 30   - Support only files in cdf, clf or bpmap format for affymetrix platform only.
401 16 Aug 07 dominic 31   - Upload the zip file into base2 without unpacking. The plugins will do the unpacking  for you.
401 16 Aug 07 dominic 32    - If  an array design already exists, the plug-in skips the cdf, bpmap or clf file.
401 16 Aug 07 dominic 33    - Please note that only a user with an administrator role may execute this plugin.
401 16 Aug 07 dominic 34
401 16 Aug 07 dominic 35   1. Go to Array Design, on the list page, Select the import tab.
410 30 Aug 07 dominic 36   2. On the screen that appears, select the AffyArrayDesignBatchImporter from the drop down list, leave the file format as auto-detect  and clicl Next
401 16 Aug 07 dominic 37   3. Select the zip file containing the array designs to import using the browse button. Click Next
401 16 Aug 07 dominic 38   4. On the next screen, click Next as the file configuration has been done for you.
401 16 Aug 07 dominic 39   5. On the next screen click Finish and wait for the job to complete. You will be shown the progress of the import in the dialog, with the page refreshing itself regularly.
401 16 Aug 07 dominic 40   
401 16 Aug 07 dominic 41 Presto!! The plugin then unzips the files , create all the array design and also attach the cdf, clf or bpmap file to the newly created array design. Do refresh the Array Design page to see the newly created array designs.
401 16 Aug 07 dominic 42
401 16 Aug 07 dominic 43 ====================================================================================================