annotate subsearch/subsearch.xml @ 0:527ecd2fc500 draft

Uploaded
author bgruening
date Thu, 15 Aug 2013 03:25:06 -0400
parents
children 125da3a296ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ctb_subsearch" name="Substructure Search" version="0.1">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
2 <description>of fingerprint data sets</description>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="2.3.2">openbabel</requirement>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
5 </requirements>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
6 <command interpreter="python">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
7
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
8 subsearch.py
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
9 -i $query
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
10 --iformat "${query.ext}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
11 --fastsearch-index "${os.path.join($fastsearch.extra_files_path,'molecule.fs')}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
12 -o "${outfile}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
13 --oformat $oformat
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
14 --max-candidates $max_candidates
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
15 --processors 10
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
16
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
17 </command>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
18 <inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
19 <param name="query" type='data' format="tabular,smi,sdf,inchi,text" label="query"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
20 <param name="fastsearch" type='data' format="obfs" label="OpenBabel Fastsearch Index"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
21 <param name="max_candidates" size="6" type="integer" value="4000" label="The maximum number of candidates"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
22 <param name='oformat' type='select' format='text' label="Output format.">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
23 <option value='smi'>SMILES</option>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
24 <option value='inchi'>InChI</option>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
25 <option value='sdf'>SD-Files</option>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
26 <option value='mol2'>mol2</option>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
27 <option value='names'>Return the molecule names only</option>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
28 </param>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
29 </inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
30 <outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
31 <data format="smi" name="outfile">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
32 <change_format>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
33 <when input="oformat" value="inchi" format="inchi"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
34 <when input="oformat" value="sdf" format="sdf"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
35 <when input="oformat" value="mol2" format="mol2"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
36 <when input="oformat" value="names" format="tabular"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
37 </change_format>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
38 </data>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
39 </outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
40 <tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
41 <test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
42 </test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
43 </tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
44 <help>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
45
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
46 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
47
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
48 **What this tool does**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
49
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
50 Substructure search in based on Open Babel FastSearch_ Index. It uses molecular fingerprints to prepare and search an index of a multi-molecule datafile.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
51
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
52 .. _FastSearch: http://openbabel.org/wiki/FastSearch
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
53
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
54 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
55
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
56 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
57
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
58 **Input**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
59
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
60 SMILES or SMARTS patterns are possible. SD- and InChI files are converted to SMILES.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
61
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
62 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
63
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
64 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
65
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
66 **Cite**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
67
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
68 `Open Babel`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
69
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
70 .. _Open Babel: http://openbabel.org/wiki/Main_Page
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
71
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
72 </help>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
73 </tool>