annotate chemfp_clustering/nxn_clustering.xml @ 1:43a9e7d9b24f draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
author bgruening
date Sun, 01 Nov 2015 10:27:01 -0500
parents 354d3c6bb894
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ctb_chemfp_nxn_clustering" name="NxN Clustering" version="0.2">
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
2 <description>of molecular fingerprints</description>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="1.7.0">numpy</requirement>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="1.1p1">chemfp</requirement>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
6 <requirement type="package" version="1.2.1">matplotlib</requirement>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
7 <requirement type="package" version="0.12.0">scipy</requirement>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
8 <requirement type="package" version="2.3.2">openbabel</requirement>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
9 </requirements>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
10 <command interpreter='python'>
1
43a9e7d9b24f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 0
diff changeset
11 <![CDATA[
0
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
12 nxn_clustering.py
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
13 -i $infile
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
14 -t $threshold
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
15 #if str($output_files) in ['both', 'image']:
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
16 --cluster $image
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
17 #end if
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
18 #if str($output_files) in ['both', 'matrix']:
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
19 --smatrix $smilarity_matrix
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
20 #end if
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
21 --oformat $oformat
1
43a9e7d9b24f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 0
diff changeset
22 ]]>
0
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
23 </command>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
24 <inputs>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
25 <param name="infile" type="data" format="fps" label="Finperprint dataset" help="Dataset missing? See TIP below"/>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
26 <param name='threshold' type='float' value='0.0' />
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
27 <param name='oformat' type='select' format='text' label="Format of the resulting picture">
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
28 <option value='png'>PNG</option>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
29 <option value='svg'>SVG</option>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
30 </param>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
31 <param name='output_files' type='select' format='text' label="Output options">
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
32 <option value='both'>NxN matrix and Image</option>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
33 <option value='image'>Image</option>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
34 <option value='matrix'>NxN Matrix</option>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
35 </param>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
36
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
37 </inputs>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
38 <outputs>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
39 <data name="image" type="data" format="svg" label="${tool.name} on ${on_string} - Cluster Image">
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
40 <filter>output_files == "both" or output_files == "image"</filter>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
41 <change_format>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
42 <when input="oformat" value="png" format="png"/>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
43 </change_format>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
44 </data>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
45 <data name="smilarity_matrix" format="binary" label="${tool.name} on ${on_string} - Similarity Matrix">
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
46 <filter>output_files == "both" or output_files == "matrix"</filter>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
47 </data>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
48 </outputs>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
49 <tests>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
50 <test>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
51 <param name="infile" ftype="fps" value="q.fps" />
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
52 <param name='treshold' value='0.75' />
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
53 <param name='output_files' value='image' />
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
54 <output ftype="svg" name="outfile" file='NxN_Clustering_on_q.svg' />
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
55 </test>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
56 </tests>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
57 <help>
1
43a9e7d9b24f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 0
diff changeset
58 <![CDATA[
0
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
59
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
60 .. class:: infomark
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
61
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
62 **What this tool does**
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
63
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
64 Generating hierarchical clusters and visualizing clusters with dendrograms.
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
65 For the clustering and the fingerprint handling the chemfp_ project is used.
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
66
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
67 .. _chemfp: http://chemfp.com/
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
68
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
69 -----
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
70
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
71 .. class:: warningmark
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
72
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
73 **Hint**
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
74
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
75 The plotting of the cluster image is sensible only with a small dataset.
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
76
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
77 -----
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
78
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
79 .. class:: infomark
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
80
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
81 **Input**
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
82
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
83 Molecular fingerprints in FPS format. Open Babel Fastsearch index is not supported.
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
84
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
85 * Example::
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
86
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
87 - fingerprints in FPS format
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
88
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
89 #FPS1
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
90 #num_bits=881
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
91 #type=CACTVS-E_SCREEN/1.0 extended=2
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
92 #software=CACTVS/unknown
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
93 #source=/home/mohammed/galaxy-central/database/files/000/dataset_423.dat
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
94 #date=2012-02-09T13:20:37
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
95 07ce04000000000000000000000000000080060000000c000000000000001a800f0000780008100000701487e960cc0bed3248000580644626004101b4844805901b041c2e
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
96 19511e45039b8b2926101609401b13e40800000000000100200000040080000010000002000000000000 55169009
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
97 07ce04000000000000000000000000000080060000000c000000000000001a800f0000780008100000701087e960cc0bed3248000580644626004101b4844805901b041c2e
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
98 19111e45039b8b2926105609401313e40800000000000100200000040080000010000002000000000000 55079807
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
99 ........
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
100
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
101 - Tanimoto threshold : 0.8 (between 0 and 1)
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
102
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
103 -----
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
104
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
105 .. class:: informark
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
106
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
107 **Output**
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
108
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
109 * Example::
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
110
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
111 .. image:: $PATH_TO_IMAGES/NxN_clustering.png
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
112
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
113 -----
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
114
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
115 .. class:: infomark
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
116
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
117 **Cite**
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
118
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
119 The chemfp_ project from Andrew Dalke!
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
120
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
121 .. _chemfp: http://chemfp.com/
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
122
1
43a9e7d9b24f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 0
diff changeset
123 ]]>
0
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
124 </help>
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
125
354d3c6bb894 Uploaded
bgruening
parents:
diff changeset
126 </tool>