plugins/base2/uk.ac.scri.batchimporter/trunk/README.txt

Code
Comments
Other
Rev Date Author Line
226 09 Jan 07 mbayer 1 GENERAL INFO
226 09 Jan 07 mbayer 2
238 20 Feb 07 mbayer 3 The BatchDataImporter plugin imports a batch of individual data files into an experiment chosen by the user. It is set up to be invoked from the detail view of a single Experiment where an import tab lets the user select a zip file that contains all the data files. On invocation it proceeds to create a new subdirectory in the directory where the file is currently located -- this subdirectory is named after the zip file minus the extension plus a timestamp in the format ddMMyy_hhmmss. The zip file is unzipped into this directory. For each file in the directory, a single RawBioAssay object is then created, and once all the data files have been processed in this way, the RawBioAssay objects just created are attached to the Experiment where the import is run from. 
226 09 Jan 07 mbayer 4
226 09 Jan 07 mbayer 5 It is assumed that all the data files are of the same data type and format -- the import will fail otherwise. It is also assumed that a suitable import configuration for the data exists already. 
226 09 Jan 07 mbayer 6
232 14 Feb 07 mbayer 7 In the case of non-Affy data, the raw data will be added to the RawBioAssay objects by physically importing it into the database. For Affy data, the cel file will be attached to the RawBioAssay objects but no actual data is imported into the database -- the raw data stays in the cel files. Affy data imports also assume that a new ArrayDesign needs to be created and this is done with the cdf file which needs to be included in the zip file with the data files. The Arraydesign object is then set on each RawBioAssay created. 
232 14 Feb 07 mbayer 8
226 09 Jan 07 mbayer 9 ============================================================
226 09 Jan 07 mbayer 10
226 09 Jan 07 mbayer 11 INSTALLATION
226 09 Jan 07 mbayer 12
226 09 Jan 07 mbayer 13 - Place batchimporter.jar into the www/plugins directory of your BASE2 installation.
226 09 Jan 07 mbayer 14
226 09 Jan 07 mbayer 15 - Create a new plugin definition: 
226 09 Jan 07 mbayer 16 1. In the BASE web client, go to Administrate -> Plugins -> Definitions.
226 09 Jan 07 mbayer 17 2. Click New.
226 09 Jan 07 mbayer 18 3. In the dialog that opens, enter "sbrn.base.BatchDataImporter" under Class.
226 09 Jan 07 mbayer 19 4. Under Path, enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/batchimporter.jar
226 09 Jan 07 mbayer 20 5. Click Save.
226 09 Jan 07 mbayer 21 The new plugin appears under the name "Batch Data Importer" in the plugins list and is now ready to use. 
226 09 Jan 07 mbayer 22
226 09 Jan 07 mbayer 23 Bear in mind that if you install plugins as an administrator you will have still have to share them to the appropriate users by manually setting the permissions on the item. 
226 09 Jan 07 mbayer 24   
226 09 Jan 07 mbayer 25 ============================================================
226 09 Jan 07 mbayer 26
226 09 Jan 07 mbayer 27 USE
226 09 Jan 07 mbayer 28
238 20 Feb 07 mbayer 29 1. Zip up into a single file the data files that make up your experiment. If your data files are Affy format (cel files) the zip file also needs to include the cdf file for your chip. Upload this file to your account on BASE (go to View -> Files -> Upload File).
226 09 Jan 07 mbayer 30 2. Create a new Experiment in the BASE web client. Make sure it is of the same data type as the data in the files you want to import. 
226 09 Jan 07 mbayer 31 3. Open the detail view of the newly created experiment and click on the import tab.
226 09 Jan 07 mbayer 32 4. In the dialog that opens, leave the settings for Plugin and File format on auto-detect and click Next.
226 09 Jan 07 mbayer 33 5. On the next screen, select the zip file that contains your data files and click Next. 
226 09 Jan 07 mbayer 34 6. The next screen reviews what the plugin knows about your setup so far, and does not need to be modified -- click Next.
226 09 Jan 07 mbayer 35 7. The next screen gives you an option for entering a job name and description but you can also go with the defaults -- click Finish. You will then be shown the progress of the batch import in the dialog, with the page refreshing itself regularly. 
226 09 Jan 07 mbayer 36
226 09 Jan 07 mbayer 37 For long imports you can close the dialog, and even log out of BASE and shut down your browser or even your computer. The Job information is stored persistently on the server and your job will execute independently of this. You can check its status by going back to the View -> Jobs menu item in the web client.
226 09 Jan 07 mbayer 38
226 09 Jan 07 mbayer 39 When the import has finished, you can check the detail view of your experiment -- the raw bioassays that have been created should be listed at the bottom of the page.
226 09 Jan 07 mbayer 40
226 09 Jan 07 mbayer 41 ============================================================
226 09 Jan 07 mbayer 42
226 09 Jan 07 mbayer 43 AUTHOR
226 09 Jan 07 mbayer 44
226 09 Jan 07 mbayer 45 Micha Bayer - Plant Bioinformatics Group, Scottish Crop Research Institute
226 09 Jan 07 mbayer 46 email: sbrn@scri.ac.uk
226 09 Jan 07 mbayer 47 web: http://www.scri.ac.uk and http://www.scri.sari.ac.uk/MichaBayer.htm
226 09 Jan 07 mbayer 48
226 09 Jan 07 mbayer 49
226 09 Jan 07 mbayer 50

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