annotate xcms_datatypes/README.txt @ 0:d00379767dbf draft default tip

Uploaded
author mish
date Wed, 23 Apr 2014 05:25:23 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d00379767dbf Uploaded
mish
parents:
diff changeset
1 README
d00379767dbf Uploaded
mish
parents:
diff changeset
2 -----------------------------------------------------------------------
d00379767dbf Uploaded
mish
parents:
diff changeset
3 XCMS Suite datatypes: A Workflow for metabolomics by ABIMS team
d00379767dbf Uploaded
mish
parents:
diff changeset
4 -----------------------------------------------------------------------
d00379767dbf Uploaded
mish
parents:
diff changeset
5
d00379767dbf Uploaded
mish
parents:
diff changeset
6 This package contains the datatypes for the XCMS suite.
d00379767dbf Uploaded
mish
parents:
diff changeset
7
d00379767dbf Uploaded
mish
parents:
diff changeset
8 --------------------------------------------------------------------
d00379767dbf Uploaded
mish
parents:
diff changeset
9 Instructions for integration of the XCMS datatypes into the workflow-system
d00379767dbf Uploaded
mish
parents:
diff changeset
10 Galaxy (http://getgalaxy.org)
d00379767dbf Uploaded
mish
parents:
diff changeset
11 --------------------------------------------------------------------
d00379767dbf Uploaded
mish
parents:
diff changeset
12
d00379767dbf Uploaded
mish
parents:
diff changeset
13 In order to install the datatypes for the XCMS Suite into your Galaxy installation, please do the following:
d00379767dbf Uploaded
mish
parents:
diff changeset
14
d00379767dbf Uploaded
mish
parents:
diff changeset
15 $galaxybase: Your galaxy-dist location
d00379767dbf Uploaded
mish
parents:
diff changeset
16
d00379767dbf Uploaded
mish
parents:
diff changeset
17 -- Add the two datatypes and sniffer to the $galaxybase/datatypes_conf.xml
d00379767dbf Uploaded
mish
parents:
diff changeset
18
d00379767dbf Uploaded
mish
parents:
diff changeset
19 <datatype extension="ms_zip" type="galaxy.datatypes.xcms:MSZip" display_in_upload="true" />
d00379767dbf Uploaded
mish
parents:
diff changeset
20 <datatype extension="rdata" type="galaxy.datatypes.xcms:RData" display_in_upload="true" />
d00379767dbf Uploaded
mish
parents:
diff changeset
21 <sniffer type="galaxy.datatypes.xcms:MSZip"/>
d00379767dbf Uploaded
mish
parents:
diff changeset
22
d00379767dbf Uploaded
mish
parents:
diff changeset
23 -- Copy xcms.py to $galaxybase/lib/galaxy/datatypes/
d00379767dbf Uploaded
mish
parents:
diff changeset
24
d00379767dbf Uploaded
mish
parents:
diff changeset
25 -- Add "import xcms" to the beginning of the file $galaxybase/lib/galaxy/datatypes/registry.py
d00379767dbf Uploaded
mish
parents:
diff changeset
26
d00379767dbf Uploaded
mish
parents:
diff changeset
27 -- Modify the $galaxybase/tools/data_source/upload.py:
d00379767dbf Uploaded
mish
parents:
diff changeset
28
d00379767dbf Uploaded
mish
parents:
diff changeset
29
d00379767dbf Uploaded
mish
parents:
diff changeset
30 -At the beginning of the file, put this line :
d00379767dbf Uploaded
mish
parents:
diff changeset
31 from galaxy.datatypes.xcms import *
d00379767dbf Uploaded
mish
parents:
diff changeset
32 -Then add the function:
d00379767dbf Uploaded
mish
parents:
diff changeset
33 def check_ms_zip( file_name ):
d00379767dbf Uploaded
mish
parents:
diff changeset
34 return MSZip().sniff( file_name )
d00379767dbf Uploaded
mish
parents:
diff changeset
35 -Add the following lines between the two <ABIMS insert lines> :
d00379767dbf Uploaded
mish
parents:
diff changeset
36
d00379767dbf Uploaded
mish
parents:
diff changeset
37 if image:
d00379767dbf Uploaded
mish
parents:
diff changeset
38 if not PIL:
d00379767dbf Uploaded
mish
parents:
diff changeset
39 image = None
d00379767dbf Uploaded
mish
parents:
diff changeset
40 # get_image_ext() returns None if nor a supported Image type
d00379767dbf Uploaded
mish
parents:
diff changeset
41 ext = get_image_ext( dataset.path, image )
d00379767dbf Uploaded
mish
parents:
diff changeset
42 data_type = ext
d00379767dbf Uploaded
mish
parents:
diff changeset
43 # Is dataset content multi-byte?
d00379767dbf Uploaded
mish
parents:
diff changeset
44 elif dataset.is_multi_byte:
d00379767dbf Uploaded
mish
parents:
diff changeset
45 data_type = 'multi-byte char'
d00379767dbf Uploaded
mish
parents:
diff changeset
46 ext = sniff.guess_ext( dataset.path, is_multi_byte=True )
d00379767dbf Uploaded
mish
parents:
diff changeset
47 # <Abims insert Lines>
d00379767dbf Uploaded
mish
parents:
diff changeset
48 # Is dataset content supported Abims datatype
d00379767dbf Uploaded
mish
parents:
diff changeset
49 elif check_ms_zip( dataset.name ):
d00379767dbf Uploaded
mish
parents:
diff changeset
50 ext = 'ms_zip'
d00379767dbf Uploaded
mish
parents:
diff changeset
51 data_type = 'ms_zip'
d00379767dbf Uploaded
mish
parents:
diff changeset
52 # </Abims insert lines >
d00379767dbf Uploaded
mish
parents:
diff changeset
53 # Is dataset content supported sniffable binary?
d00379767dbf Uploaded
mish
parents:
diff changeset
54
d00379767dbf Uploaded
mish
parents:
diff changeset
55
d00379767dbf Uploaded
mish
parents:
diff changeset
56
d00379767dbf Uploaded
mish
parents:
diff changeset
57 Last but not least, restart Galaxy.