Changeset 401

Timestamp:

Aug 16, 2007, 11:12:07 AM (16 years ago)

Author:

dominic

Message:

istallation and usage instructioin read me .txt for the affy array design wiki page

File:

• trunk/uk/ac/ebi/AffyArrayDesignBatchImporter/README.txt (modified) (1 diff)

trunk/uk/ac/ebi/AffyArrayDesignBatchImporter/README.txt

@@ +1 @@
+Release Note of Affymetrix Array Design Batch Importer
+============================================================
+General Information:
+---------------------
+
+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.
+
+========================================================================================================
+
+To Install the plugin:
+----------------------
+  - Place AffyArrayDesignBatchImporter.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server. 
+  - Place ebi-plugins-utils.jar in your base installation class path : $BASE2_HOME/web-inf/lib
+  - Install as new plugins uk.ac.ebi.nugo.plugins.AffyArrayDesignBatchImporter.jar contained in  $BASE_HOME/www/plugins/AffyArrayDesignBatchImporter.jar .
+  
+  1. In the BASE web client, go to Administrate->Plugins->Definition
+  2. Click New to define the plugin. 
+  3. Set the class and path parameters, in the dialog that opens
+    Class: uk.ac.ebi.nugo.plugins.AffyArrayDesignBatchImporter.jar
+    Path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/AffyArrayDesignBatchImporter.jar 
+  4. Click Save
+  
+  The new plugins appears under the name "Affymetrix Array Design Batch Importer" in the plugins list and is now ready for use. 
+
+  For other base 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.
+
+  General Installation instruction is available at:  
+http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
+
+===============================================================================================
+To use the plugin:
+--------------------
+  - Support only files in cdf, clf or bpmap format for affymetrix platform only.
+  - Upload the zip file into base2 without unpacking. The plugins will do the unpacking  for you.
+  - 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.
+
+  1. Go to Array Design, on the list page, Select the import tab.
+  2. On the screen that appears, select the AffyArrayDesignBatchImporter form the drop down list, leave the file format as auto-detect  and clicl Next
+  3. Select the zip file containing the array designs to import using the browse button. Click Next
+  4. On the next screen, click Next as the file configuration has been done for you.
+  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.
+  
+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.
+
+====================================================================================================