annotate filter/ob_remSmall.xml @ 11:77b82f259298

ChemicalToolBoX update.
author Bjoern Gruening <bjoern.gruening@gmail.com>
date Mon, 27 May 2013 16:52:53 +0200
parents 6493d130f018
children 3d3e7c1d0f49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6493d130f018 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ctb_remSmall" name="Remove small molecules" version="1.0">
6493d130f018 Uploaded
bgruening
parents:
diff changeset
2 <description></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 obabel
6493d130f018 Uploaded
bgruening
parents:
diff changeset
9 -i"${infile.ext}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
10 "${infile}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
11 -ocopy
6493d130f018 Uploaded
bgruening
parents:
diff changeset
12 -O "${outfile}"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
13 --filter "atoms > $cutoff"
6493d130f018 Uploaded
bgruening
parents:
diff changeset
14 -e
6493d130f018 Uploaded
bgruening
parents:
diff changeset
15 2>&#38;1
6493d130f018 Uploaded
bgruening
parents:
diff changeset
16 </command>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
17 <inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
18 <param name="infile" format="sdf,mol,mol2,cml,inchi,smi" type="data" label="Molecular input file" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
19 <param name="cutoff" size="3" type="integer" value="5" label="Specify the cut-off value (only molecules with more than this number of atoms will pass the filter)" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
20 </inputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
21 <outputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
22 <data format_source="infile" name="outfile" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
23 </outputs>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
24 <tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
25 <test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
26 <param name="infile" ftype="smi" value="3_mol.smi" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
27 <param name="cutoff" value="5" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
28 <output name="outfile" ftype="smi" file="obremsmall_on_3_mol.smi" />
6493d130f018 Uploaded
bgruening
parents:
diff changeset
29 </test>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
30 </tests>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
31 <help>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
32
6493d130f018 Uploaded
bgruening
parents:
diff changeset
33 .. class:: infomark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
34
6493d130f018 Uploaded
bgruening
parents:
diff changeset
35 **What does this tool do?**
6493d130f018 Uploaded
bgruening
parents:
diff changeset
36
6493d130f018 Uploaded
bgruening
parents:
diff changeset
37 This tool filters a library of compounds and removes small molecules.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
38
6493d130f018 Uploaded
bgruening
parents:
diff changeset
39 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
40
6493d130f018 Uploaded
bgruening
parents:
diff changeset
41 .. class:: warningmark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
42
6493d130f018 Uploaded
bgruening
parents:
diff changeset
43 **Tip:** some libraries may contain molecules without 1D/3D descriptor. These molecules may provoke the crashing of any other tool. As a general rule, the user is strongly adviced to run this tool before proceeding to any further step.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
44
6493d130f018 Uploaded
bgruening
parents:
diff changeset
45 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
46
6493d130f018 Uploaded
bgruening
parents:
diff changeset
47 .. class:: infomark
6493d130f018 Uploaded
bgruening
parents:
diff changeset
48
6493d130f018 Uploaded
bgruening
parents:
diff changeset
49 **Output format:** is the same as the input file format.
6493d130f018 Uploaded
bgruening
parents:
diff changeset
50
6493d130f018 Uploaded
bgruening
parents:
diff changeset
51 -----
6493d130f018 Uploaded
bgruening
parents:
diff changeset
52
6493d130f018 Uploaded
bgruening
parents:
diff changeset
53 **This tool uses OpenBabel:** The Open Babel Package, version 2.3.0 http://openbabel.sourceforge.net/
6493d130f018 Uploaded
bgruening
parents:
diff changeset
54
6493d130f018 Uploaded
bgruening
parents:
diff changeset
55 </help>
6493d130f018 Uploaded
bgruening
parents:
diff changeset
56 </tool>