annotate osra.xml @ 20:4f0d88f40ea1 draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
author bgruening
date Sun, 01 Nov 2015 10:34:50 -0500
parents b8c0edfefc91
children 6cafe4f5d181
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
d97d51e9bb95 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 13
diff changeset
1 <tool id="ctb_osra" name="Molecule recognition" version="0.3">
3
deccc074dbfb Uploaded
bgruening
parents: 2
diff changeset
2 <description>in Images or PDF documents (OSRA)</description>
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
11
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
4 <requirement type="package" version="2.0.0">osra</requirement>
13
ab9e2350406b Uploaded
bgruening
parents: 11
diff changeset
5 <requirement type="package" version="2.3.2">openbabel</requirement>
ab9e2350406b Uploaded
bgruening
parents: 11
diff changeset
6 <requirement type="package" version="1.3.18">graphicsmagick</requirement>
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
7 </requirements>
3
deccc074dbfb Uploaded
bgruening
parents: 2
diff changeset
8 <command interpreter='python'>
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
9 <![CDATA[
2
abe9670bfc44 Uploaded
bgruening
parents: 0
diff changeset
10 ## OSRA_DATA_FILES is set during the toolshed Installation
abe9670bfc44 Uploaded
bgruening
parents: 0
diff changeset
11 ## if it is not set, use the standard configuration and hope the best
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
12 osra.py -f $oformat $infile
3
deccc074dbfb Uploaded
bgruening
parents: 2
diff changeset
13 -l \$OSRA_DATA_FILES/spelling.txt -a \$OSRA_DATA_FILES/superatom.txt
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
14
3
deccc074dbfb Uploaded
bgruening
parents: 2
diff changeset
15 ## further additions of OSRA parameter should go after -l and -a
deccc074dbfb Uploaded
bgruening
parents: 2
diff changeset
16 ## because -l and -a can be removed by the python wrapper
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
17
11
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
18 $confidence
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
19 $adaptive
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
20 $thinning
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
21
2
abe9670bfc44 Uploaded
bgruening
parents: 0
diff changeset
22 > $outfile
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
23 ]]>
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
24 </command>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
25 <inputs>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
26 <param name="infile" type="data" format="png,pdf" label="Image or PDF with molecules"/>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
27 <param name="oformat" type="select" label="Output molecule format">
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
28 <option value="can">SMILES</option>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
29 <option value="sdf">SDF</option>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
30 </param>
11
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
31 <param name="confidence" type="boolean" label="Print out confidence estimate (-p)" truevalue="-p" falsevalue="" checked="true" />
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
32 <param name="adaptive" type="boolean" label="Adaptive thresholding pre-processing, useful for low light/low contrast images (-i)" truevalue="-i" falsevalue="" checked="false" />
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
33 <param name="thinning" type="boolean" label="Additional thinning/scaling down of low quality documents (-j)" truevalue="-j" falsevalue="" checked="false" />
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
34
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
35 </inputs>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
36 <outputs>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
37 <data name="outfile" type="data" format="sdf">
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
38 <change_format>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
39 <when input="oformat" value="can" format="smi"/>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
40 </change_format>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
41 </data>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
42 </outputs>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
43 <tests>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
44 <test>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
45 <param name="infile" ftype="png" value="CID_2244.png"/>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
46 <param name="oformat" value="sdf"/>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
47 <output name="outfile" ftype="sdf" file="osra_on_CID2244.sdf"/>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
48 </test>
11
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
49 <test>
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
50 <param name="infile" ftype="png" value="2008001635_153_chem.png"/>
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
51 <param name="oformat" value="can"/>
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
52 <output name="outfile" ftype="sdf" file="2008001635_153_chem.smi"/>
143a63ca2bca Uploaded
bgruening
parents: 3
diff changeset
53 </test>
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
54
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
55 </tests>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
56 <help>
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
57 <![CDATA[
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
58
17
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
59 .. class:: infomark
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
60
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
61 **What this tool does**
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
62
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
63 OSRA_ (Optical Structure Recognition Application) is a utility designed to convert graphical representations of chemical structures into SMILES or SDF. It generates the SMILES or SDF representation of any molecular structure image within a document which is parseable by GraphicMagick.
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
64
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
65 .. _OSRA: http://cactus.nci.nih.gov/osra/
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
66
17
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
67 -----
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
68
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
69 .. class:: infomark
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
70
17
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
71 **Cite**
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
72
17
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
73 Igor V Filippov and Marc C Nicklaus - `Optical Structure Recognition Software To Recover Chemical Information: OSRA, An Open Source Solution`_
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
74
b8c0edfefc91 ChemicalToolBoX update.
Bjoern Gruening <bjoern.gruening@gmail.com>
parents: 16
diff changeset
75 .. _`Optical Structure Recognition Software To Recover Chemical Information: OSRA, An Open Source Solution`: http://pubs.acs.org/doi/abs/10.1021/ci800067r
20
4f0d88f40ea1 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/osra commit a44c0a13283e873a740eabcad04f021208290dfe-dirty
bgruening
parents: 17
diff changeset
76 ]]>
0
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
77 </help>
efd9c309b8f7 Uploaded
bgruening
parents:
diff changeset
78 </tool>