annotate filter/multi_obgrep.xml @ 1:b52872a1755a draft

update cheminfolib dependency
author bgruening
date Wed, 21 Aug 2013 03:06:02 -0400
parents 527ecd2fc500
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_multi_obgrep" name="Multi Compound Search" version="0.1">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
2 <description>an advanced molecular grep program using SMARTS</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 multi_obgrep.py
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
9 -i $infile
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
10 --iformat ${infile.ext}
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
11 -q $query
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
12 -o "${outfile}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
13 $invert_matches
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
14 --n-times $n_times
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
15 $only_name
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
16 $full_match
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
17 $number_of_matches
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
18 --processors 10
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
19
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
20 </command>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
21 <inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
22 <param name="infile" type="data" format="sdf,mol,mol2,cml,inchi,smi" label="Compound File" help="Specify a compound file in SDF Format"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
23 <param name="query" type='data' format="tabular,text" label="Query file" help="One SMARTS pattern in each line."/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
24 <param name="invert_matches" type="boolean" label="Invert the matching, print non-matching molecules (-v)" truevalue="--invert-matches" falsevalue="" checked="false" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
25 <param name="n_times" type="integer" value="0" label="Print a molecule only if the pattern occurs # times inside the molecule" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
26 <param name="only_name" type="boolean" label="Only print the name of the molecules (-n)" truevalue="--only-name" falsevalue="" checked="false" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
27 <param name="full_match" type="boolean" label="Full match, print matching-molecules only when the number of heavy atoms is also equal to the number of atoms in the SMARTS pattern (-f)" truevalue="--full-match" falsevalue="" checked="false" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
28 <param name="number_of_matches" type="boolean" label="Print the number of matches (-c)" truevalue="--number-of-matches" falsevalue="" checked="false" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
29 </inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
30 <outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
31 <data name="outfile" format_source="infile" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
32 </outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
33 <tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
34 <test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
35 </test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
36 </tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
37 <help>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
38
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
39 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
40
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
41 **What this tool does**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
42
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
43 Uses the Open Babel Obgrep_ to search for molecules inside multi-molecule files (e.g. SMI, SDF, etc.) or across multiple files.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
44 It is known that not all SMARTS features from the Daylight Toolkit are supported, please have a look here_.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
45
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
46 .. _Obgrep: http://openbabel.org/wiki/Obgrep
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
47 .. _here: http://openbabel.org/wiki/SMARTS
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
48
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
49 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
50
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
51 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
52
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
53 **Input**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
54
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
55 | - `SD-Format`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
56 | - `SMILES Format`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
57
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
58 .. _SD-Format: http://en.wikipedia.org/wiki/Chemical_table_file
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
59 .. _SMILES Format: http://en.wikipedia.org/wiki/Simplified_molecular_input_line_entry_specification
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
60
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
61 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
62
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
63 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
64
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
65 **Output**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
66
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
67 Same as input format.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
68
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
69 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
70
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
71 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
72
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
73 **Cite**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
74
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
75 N M O'Boyle, M Banck, C A James, C Morley, T Vandermeersch, and G R Hutchison - `Open Babel: An open chemical toolbox.`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
76
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
77 .. _`Open Babel: An open chemical toolbox.`: http://www.jcheminf.com/content/3/1/33
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
78
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
79 `Open Babel`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
80
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
81 .. _`Open Babel`: http://openbabel.org/wiki/Main_Page
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
82
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
83 </help>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
84 </tool>