annotate mordred_descriptors.xml @ 1:e2f40a02f31a draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 7c47e7409a8cb19e20b4424329f5d0d9470f3b00
author bgruening
date Tue, 04 Jun 2019 10:29:10 -0400
parents ea68b86303e2
children d074b0c2b54f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
1 <tool id="ctb_mordred_descriptors" name="Calculate molecular descriptors" version="0.1.0">
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
2 <description>with Mordred</description>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
3 <requirements>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
4 <requirement type="package" version="1.1.2">mordred</requirement>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
5 </requirements>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
7 python '$__tool_directory__/mordred_descriptors.py'
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
8 -i '${input}'
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
9 --iformat '${input.ext}'
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
10 -o '${output}'
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
11 $header
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
12 $use_3d
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
13 ]]></command>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
14 <inputs>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
15 <param name="input" format="smi,sdf,inchi" type="data" label="Molecule data"
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
16 help="SDF, SMILES or InChi format"/>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
17 <param name='header' type='boolean' truevalue='--header' falsevalue=''
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
18 label='Include a header line' help='Include names of the descriptors as the first line in the output file'/>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
19 <param name='use_3d' type='boolean' truevalue='--3d' falsevalue=''
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
20 label='Calculate 3D descriptors' help='Include 3D as well as 2D descriptors - only valid if an SD-file is selected'/>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
21 </inputs>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
22 <outputs>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
23 <data name="output" format="tabular" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
24 </outputs>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
25 <tests>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
26 <test>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
27 <param name="input" ftype='sdf' value="10mol.sdf" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
28 <param name="header" value="True" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
29 <param name="use_3d" value="True" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
30 <output name="output" ftype='tabular' file="10sdf.tab" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
31 </test>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
32 <test>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
33 <param name="input" ftype='smi' value="8mol.smi" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
34 <param name="header" value="True" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
35 <param name="use_3d" value="False" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
36 <output name="output" ftype='tabular' file="8smi.tab" />
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
37 </test>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
38 </tests>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
39
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
40 <help><![CDATA[
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
41 Calculates up to 1825 molecular descriptors using the Mordred package. A list of all
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
42 descriptors is located here_.
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
43
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
44 .. _here: https://github.com/simonbray/mordred-descriptors
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
45
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
46 .. class:: infomark
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
47
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
48 **Input**
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
49
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
50 A file containing multiples chemical structures, either in SMILES, InChi or SDF format.
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
51
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
52 -----
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
53
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
54 .. class:: infomark
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
55
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
56 **Output**
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
57
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
58 A tabular file, in which each column represents a molecular descriptor (1613 in total,
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
59 or 1825 if 3D descriptors are included). Each row describes a single molecule. Empty
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
60 cells indicate that a descriptor could not be calculated for that molecule. Rows which
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
61 are entirely empty most likely indicate a wrongly encoded molecule.
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
62
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
63 ]]></help>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
64 <citations>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
65 <citation type="doi">10.1186/s13321-018-0258-y</citation>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
66 </citations>
ea68b86303e2 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/mordred commit 4ce352d9c9f3f1808e2ab6c019c534fd3e805959
bgruening
parents:
diff changeset
67 </tool>