annotate featurestein.xml @ 0:0eb24d808e75 draft default tip

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
author bgruening
date Mon, 27 Jul 2020 11:31:14 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
1 <tool id="featurestein" name="'FeatureStein' fragment overlay scoring" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
2 <description>feature overlay scoring</description>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
3 <macros>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
4 <import>macros.xml</import>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
5 <token name="@GALAXY_VERSION@">0</token>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
6 </macros>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
8 <command detect_errors="exit_code">
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
9 <![CDATA[
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
10 featurestein_generate -i '$fragments' -if sdf &&
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
11 featurestein_score -i '$ligands' -if sdf -f featurestein.p -o output -of sdf --no-gzip
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
12 ]]>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
13 </command>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
14 <inputs>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
15 <param name="fragments" format="sdf" type="data" label="Fragments to generate feature maps" help="In SDF format"/>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
16 <param name="ligands" format="sdf" type="data" label="Ligands to score" help="In SDF format"/>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
17 </inputs>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
18 <outputs>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
19 <data name="output" format="sdf" from_work_dir="output.sdf" label="The scored ligands"/>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
20 </outputs>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
21 <tests>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
22 <test>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
23 <param name="fragments" ftype='sdf' value="hits-17.sdf" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
24 <param name="ligands" ftype='sdf' value="poses.sdf" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
25 <output name="output" ftype="sdf">
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
26 <assert_contents>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
27 <has_n_lines n="692" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
28 <has_text text="FeatureStein_Qual" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
29 <has_text text="FeatureStein_Quant" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
30 </assert_contents>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
31 </output>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
32 </test>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
33 </tests>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
34 <help>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
35 <![CDATA[
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
36
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
37 .. class:: infomark
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
38
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
39 **What this tool does**
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
40
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
41 FeatureStein involves use of merged RDKit feature maps to score ligand poses in terms of how well the features overlap
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
42 with features from a set of ligands, typically fragment screening hits. The features are molecular features like
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
43 hydrogen bond donors and acceptors or hydrophobic groups.
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
44 See this Jupyter notebook for more information: https://github.com/tdudgeon/jupyter_mpro/blob/master/featurestein/FeatureStein.ipynb
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
45 and this blog for more general info on RDKit feature maps:
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
46 http://rdkit.blogspot.com/2017/11/using-feature-maps.html
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
47
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
48 This module generates the merged feature maps from a set of molecules (typically fragment screening hits) and then.
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
49 scores a set of ligands using those merged feature maps.
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
50
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
51 The fields that are created are:
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
52
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
53 - FeatureStein_Quant: the sum of the scores for each feature in the ligand
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
54 - FeatureStein_Qual: the FeatureStein_Quant score divided by the number of features (number between 0 and 1)
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
55
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
56 -----
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
57
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
58 .. class:: infomark
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
59
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
60 **Input**
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
61
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
62 - fragments: SD-file of fragments to generate feature maps and merge
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
63 - ligands: SD-file of ligands to score
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
64
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
65 -----
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
66
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
67 .. class:: infomark
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
68
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
69 **Output**
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
70
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
71 SD-file of the ligands with the FeatureStein scores added.
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
72
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
73 ]]>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
74 </help>
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
75 <expand macro="citations" />
0eb24d808e75 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/im-pipelines commit d1d0ec4ebc97b2274b18a0aab99f41addd5357ae"
bgruening
parents:
diff changeset
76 </tool>