annotate modify/ob_addh.xml @ 2:125da3a296ca draft default tip

Uploaded
author bgruening
date Wed, 15 Jul 2015 12:13:08 -0400
parents 527ecd2fc500
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
1 <tool id="ctb_ob_addh" name="Add hydrogen atoms" version="1.0">
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
2 <description>at a certain pH value</description>
527ecd2fc500 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>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
4 <requirements>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="2.3.2">openbabel</requirement>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
6 </requirements>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
7 <command interpreter="python">
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
8 <![CDATA[
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
9 ob_addh.py
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
10 -i "${infile}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
11 --iformat "${infile.ext}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
12 -o "${outfile}"
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
13 $polar
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
14 --pH "${pH_value}"
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
15 ]]>
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
16 </command>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
17 <inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
18 <param name="infile" type="data" format="sdf,smi,mol,mol2,cml,inchi" label="Select input file"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
19 <param name="polar" type="boolean" truevalue="--polar" falsevalue="" label="Add hydrogens to polar atoms only"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
20 <param name="pH_value" type="float" size="4" value="7.4" label="Specify pH value"/>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
21 </inputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
22 <outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
23 <data format_source="infile" name="outfile" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
24 </outputs>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
25 <tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
26 <test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
27 <param name="infile" value="CID_2244.can" ftype="smi" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
28 <param name="polar" value="--polar" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
29 <param name="pH_value" value="7.4" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
30 <output name="outfile" file="CID_2244_addh.can" ftype="can" />
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
31 </test>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
32 </tests>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
33 <help>
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
34 <![CDATA[
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
35
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
36 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
37
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
38 **What this tool does**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
39
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
40 Parses a molecular file and adds hydrogen atoms at a user-defined pH value.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
41
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
42 * Protocol::
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
43
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
44 1. The hydrogen atoms included in the input molecule are deleted.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
45 2. Protonation state is predicted at the target pH and the corresponding hydrogen atoms added accordingly.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
46
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
47 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
48
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
49 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
50
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
51 **Input**
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
52
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
53 3D format files are required, e.g. SDF_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
54
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
55 .. _SDF: http://en.wikipedia.org/wiki/Chemical_table_file
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
56
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
57 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
58
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
59 .. class:: warningmark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
60
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
61 **Hint**
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
62
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
63 To avoid possible crashes, only molecules with more than five heavy atoms are parsed.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
64
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
65 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
66
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
67 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
68
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
69 **Output**
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
70
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
71 Same output format as the input format.
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
72
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
73 -----
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
74
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
75 .. class:: infomark
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
76
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
77 **Cite**
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 N M O'Boyle, C Morley and G R Hutchison - `Pybel: a Python wrapper for the OpenBabel cheminformatics toolkit`_
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
84
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
85 .. _`Pybel: a Python wrapper for the OpenBabel cheminformatics toolkit`: http://www.biomedcentral.com/content/pdf/1752-153X-2-5.pdf
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
86
2
125da3a296ca Uploaded
bgruening
parents: 0
diff changeset
87 ]]>
0
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
88 </help>
527ecd2fc500 Uploaded
bgruening
parents:
diff changeset
89 </tool>