Mercurial > repos > bgruening > simsearch

annotate simsearch.xml @ 19:520e02f04477 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 7fb96a3844b4771084f18de2346ed6d5e241d839"
author bgruening
date Sat, 25 Sep 2021 19:06:56 +0000
parents f90b44d95052
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
f90b44d95052 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 944ea4bb8a9cd4244152a4a4fecd0485fabc2ad0"
bgruening
parents: 17
diff changeset
1 <tool id="ctb_simsearch" name="Similarity search" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
f90b44d95052 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 944ea4bb8a9cd4244152a4a4fecd0485fabc2ad0"
bgruening
parents: 17
diff changeset
2 <description>of fingerprint data sets with chemfp</description>
f90b44d95052 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 944ea4bb8a9cd4244152a4a4fecd0485fabc2ad0"
bgruening
parents: 17
diff changeset
3 <macros>
19
520e02f04477 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 7fb96a3844b4771084f18de2346ed6d5e241d839"
bgruening
parents: 18
diff changeset
4 <token name="@TOOL_VERSION@">1.6.1</token>
18
f90b44d95052 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 944ea4bb8a9cd4244152a4a4fecd0485fabc2ad0"
bgruening
parents: 17
diff changeset
5 <token name="@GALAXY_VERSION@">0</token>
f90b44d95052 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 944ea4bb8a9cd4244152a4a4fecd0485fabc2ad0"
bgruening
parents: 17
diff changeset
6 </macros>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
7 <requirements>
19
520e02f04477 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit 7fb96a3844b4771084f18de2346ed6d5e241d839"
bgruening
parents: 18
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">chemfp</requirement>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
9 </requirements>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
10 <command>
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
11 <![CDATA[
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
12 #if $method_opts.method_opts_selector == "chemfp":
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
13 ln -s '${method_opts.query_opts.targets}' ./targets.fps &&
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
14
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
15 #if $method_opts.query_opts.query_opts_selector == "normal":
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
16 ln -s '${method_opts.query_opts.query}' ./query.fps &&
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
17 #end if
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
18
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
19 simsearch
14
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
20 #if int($method_opts.knn) == 0:
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
21 #set $k = 'all'
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
22 ## count is only available if k nearest neighbor search is disabled
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
23 $method_opts.counts
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
24 #else:
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
25 #set $k = int($method_opts.knn)
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
26 #end if
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
27
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
28 -k $k
14
47d2bf691908 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
29 --threshold $method_opts.threshold
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
30 -o ./output.fps
12
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
31
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
32 ## build and search an in-memory data structure (faster for multiple queries)
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
33 --memory
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
34
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
35 #if $method_opts.query_opts.query_opts_selector == "normal":
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
36 -q ./query.fps
12
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
37 #else:
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
38 --NxN
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
39 #end if
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
40
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
41 ./targets.fps
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
42 &&
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
43 mv ./output.fps '${outfile}'
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
44 #else:
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
45 ## OpenBabel needs the original molecule file (molecule.'fileformat') next to the fastsearch index (molecule.fs). We use a composite datatype to accomplish that.
15
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
46 ## Furthermore OpenBabel is really picky with file extensions. We need to specify every datatype. I did not find a solution to specify the query-filetype.
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
47 ## A workaround is to create a symlink with a proper file-extension.
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
48 ln -s '$method_opts.query' ./temp_query.$method_opts.query.ext
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
49 obabel
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
50 -i fs '$method_opts.fastsearch.files_path/molecule.fs'
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
51 -S ./temp_query.$method_opts.query.ext
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
52 -at${method_opts.threshold}
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
53 -O '${outfile}'
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
54 -osmi
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
55 -aa
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
56 #end if
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
57 ]]>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
58 </command>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
59 <inputs>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
60 <conditional name="method_opts">
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
61 <param name="method_opts_selector" type="select" label="Subject database/sequences">
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
62 <option value="chemfp">Chemfp fingerprint file</option>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
63 <option value="obabel">OpenBabel Fastsearch Index</option>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
64 </param>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
65 <when value="chemfp">
12
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
66 <conditional name="query_opts">
17
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
67 <param name="query_opts_selector" type="select" label="Query mode">
12
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
68 <option value="normal">Query molecules are stores in a separate file</option>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
69 <option value="nxn">Target molecules are also queries (NxN)</option>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
70 </param>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
71 <when value="normal">
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
72 <param name='query' type='data' format="fps" label='Query molecules'/>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
73 <param name='targets' type='data' format="fps" label='Target molecules'/>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
74 </when>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
75 <when value="nxn">
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
76 <param name='targets' type='data' format="fps" label='Target moleculs'/>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
77 </when>
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
78 </conditional>
17
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
79 <param name='knn' type='integer' value='0' label='Select the k nearest neighbors' help='0 means all neighbors'>
12
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
80 <validator type="in_range" min="0" />
526f6e88fbe7 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 7
diff changeset
81 </param>
17
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
82 <param name='threshold' type='float' value='0.7' label='Minimum similarity score threshold' />
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
83 <param name="counts" type="boolean" truevalue="-c" falsevalue="" checked="false" label="Report counts (-c)" help="Is ignored if k nearest neighbor search is enabled" />
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
84 </when>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
85 <when value="obabel">
17
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
86 <param name="query" type='data' format="smi,mol,sdf,inchi" label="Query"/>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
87 <param name="fastsearch" type='data' format="obfs" label="OpenBabel Fastsearch Index"/>
17
e1e2746c8688 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit ed9b6859de648aa5f7cde483732f5df20aaff90e
bgruening
parents: 16
diff changeset
88 <param name="threshold" type='float' label="Minimum similarity score threshold" value='0.7'/>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
89 </when>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
90 </conditional>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
91
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
92 </inputs>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
93 <outputs>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
94 <data name="outfile" format="tabular" />
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
95 </outputs>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
96 <tests>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
97 <test>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
98 <param name="targets" ftype="fps" value="targets.fps"/>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
99 <param name="query" ftype="fps" value="q.fps"/>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
100 <param name="k" value='4'/>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
101 <param name="th" value='0.7'/>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
102 <output name="outfile" ftype="tabular" file="simsearch_on_tragets_and_q.tabular"/>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
103 </test>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
104 </tests>
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
105 <help>
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
106 <![CDATA[
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
107
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
108
15
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
109 .. class:: infomark
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
110
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
111 **What this tool does**
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
112
15
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
113 Similarity searches using a variety of different fingerprints using either the chemfp_ FPS type or the Open Babel FastSearch_ index.
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
114
15
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
115 .. _chemfp: http://chemfp.com/
b4eaf75cac77 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 14
diff changeset
116 .. _FastSearch: http://openbabel.org/wiki/FastSearch
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
117
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
118
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
119 ]]>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
120 </help>
16
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
121 <citations>
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
122 <citation type="doi">10.1186/1758-2946-3-33</citation>
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
123 <citation type="doi">10.1186/1758-2946-5-S1-P36</citation>
987b62da416d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/simsearch commit d786052cd04f8b25eb4aff80b1b9724f62031b61
bgruening
parents: 15
diff changeset
124 </citations>
0
b4cbee77896d Uploaded
bgruening
parents:
diff changeset
125 </tool>