annotate filter/ob_grep.xml @ 22:b4ba90dcfde0 default tip

ChemicalToolBoX update.
author Bjoern Gruening <bjoern.gruening@gmail.com>
date Tue, 23 Jul 2013 19:00:18 +0200
parents 3d3e7c1d0f49
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ctb_obgrep" name="Compound Search" version="0.1">
6493d130f018 Uploaded
bgruening
parents:
diff changeset
2 <description>an advanced molecular grep program using SMARTS</description>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
3 <parallelism method="multi" split_inputs="infile" split_mode="to_size" split_size="10000" shared_inputs="" merge_outputs="outfile"></parallelism>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
4 <requirements>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="2.3.2">openbabel</requirement>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
6 </requirements>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
7 <command>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
8 ## The command is a Cheetah template which allows some Python based syntax.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
9 ## Lines starting hash hash are comments. Galaxy will turn newlines into spaces
6493d130f018 Uploaded
bgruening
parents:
diff changeset
10 obgrep
6493d130f018 Uploaded
bgruening
parents:
diff changeset
11
6493d130f018 Uploaded
bgruening
parents:
diff changeset
12 $invert_matches
6493d130f018 Uploaded
bgruening
parents:
diff changeset
13 #if $n_times != 0:
6493d130f018 Uploaded
bgruening
parents:
diff changeset
14 -t $n_times
6493d130f018 Uploaded
bgruening
parents:
diff changeset
15 #end if
6493d130f018 Uploaded
bgruening
parents:
diff changeset
16
6493d130f018 Uploaded
bgruening
parents:
diff changeset
17 $only_name
6493d130f018 Uploaded
bgruening
parents:
diff changeset
18 $full_match
6493d130f018 Uploaded
bgruening
parents:
diff changeset
19 $number_of_matches
6493d130f018 Uploaded
bgruening
parents:
diff changeset
20 -i ${infile.ext}
6493d130f018 Uploaded
bgruening
parents:
diff changeset
21 "${smarts_pattern}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
22 "${infile}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
23 > "${outfile}" 2>&#38;1
6493d130f018 Uploaded
bgruening
parents:
diff changeset
24 </command>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
25 <inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
26 <param name="infile" type="data" format="sdf,mol,mol2,cml,inchi,smi" label="Compound File" help="Specify a compound file in SDF Format."/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
27 <param name="smarts_pattern" type="text" format="text" label="SMARTS Pattern" help="Specify a SMARTS Pattern for your search."/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
28 <param name="invert_matches" type="boolean" label="Invert the matching, print non-matching molecules" truevalue="-v" falsevalue="" checked="false" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
29 <param name="n_times" type="integer" value="0" label="Print a molecule only if the pattern occurs # times inside the molecule" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
30 <param name="only_name" type="boolean" label="Only print the name of the molecules" truevalue="-n" falsevalue="" checked="false" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
31 <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" truevalue="-f" falsevalue="" checked="false" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
32 <param name="number_of_matches" type="boolean" label="Print the number of matches" truevalue="-c" falsevalue="" checked="false" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
33 </inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
34 <options sanitize="False"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
35 <outputs>
11
77b82f259298 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 0
diff changeset
36 <data name="outfile" format_source="infile" label="${tool.name} on ${on_string}"/>
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
37 </outputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
38 <tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
39 <test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
40 <param name="infile" ftype="smi" value="8_mol.smi"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
41 <param name="smarts_pattern" value="CO"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
42 <param name="invert_matches" value="" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
43 <param name="n_times" value="0"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
44 <param name="only_name" value="" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
45 <param name="full_match" value="" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
46 <param name="number_of_matches" value="" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
47 <output name="outfile" ftype="smi" file="obgrep_on_8_mol.smi"/>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
48 </test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
49 </tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
50 <help>
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
51
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
52 .. class:: infomark
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
53
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
54 **What this tool does**
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
55
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
56 Uses the Open Babel Obgrep_ to search for molecules inside multi-molecule files (e.g. SMI, SDF, etc.) or across multiple files.
15
ec87a42dccec ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 11
diff changeset
57 It is known that not all SMARTS features from the Daylight Toolkit are supported, please have a look here_.
ec87a42dccec ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 11
diff changeset
58
ec87a42dccec ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 11
diff changeset
59
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
60 .. _Obgrep: http://openbabel.org/wiki/Obgrep
15
ec87a42dccec ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 11
diff changeset
61 .. _here: http://openbabel.org/wiki/SMARTS
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
62
6493d130f018 Uploaded
bgruening
parents:
diff changeset
63 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
64
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
65 .. class:: infomark
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
66
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
67 **Input**
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
68
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
69 | - `SD-Format`_
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
70 | - `SMILES Format`_
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
71
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
72 .. _SD-Format: http://en.wikipedia.org/wiki/Chemical_table_file
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
73 .. _SMILES Format: http://en.wikipedia.org/wiki/Simplified_molecular_input_line_entry_specification
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
74
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
75 -----
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
76
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
77 .. class:: infomark
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
78
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
79 **Output**
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
80
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
81 Same as input format.
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
82
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
83 -----
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
84
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
85 .. class:: infomark
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
86
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
87 **Cite**
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
88
16
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
89 N M O'Boyle, M Banck, C A James, C Morley, T Vandermeersch, and G R Hutchison - `Open Babel: An open chemical toolbox.`_
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
90
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
91 .. _`Open Babel: An open chemical toolbox.`: http://www.jcheminf.com/content/3/1/33
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
92
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
93 `Open Babel`_
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
94
3d3e7c1d0f49 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 15
diff changeset
95 .. _`Open Babel`: http://openbabel.org/wiki/Main_Page
15
ec87a42dccec ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 11
diff changeset
96
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
97 </help>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
98 </tool>