annotate chembl_structure_pipeline.xml @ 0:2f59c6239f25 draft default tip

"planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
author bgruening
date Sat, 10 Oct 2020 09:43:40 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
1 <tool id="chembl_structure_pipeline" name="ChEMBL structure pipeline" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
2 <description>for curation and standardizing of molecular structures</description>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
3 <macros>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
4 <token name="@TOOL_VERSION@">1.0.0</token>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
5 <token name="@GALAXY_VERSION@">0</token>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
6 </macros>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
7 <requirements>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">chembl_structure_pipeline</requirement>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
9 </requirements>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
10 <command><![CDATA[
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
11 python '$__tool_directory__/structure_pipeline.py'
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
12 --input '$input'
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
13 --output '$output'
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
14 $standardize
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
15 $get_parent
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
16 $check
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
17 ]]>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
18 </command>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
19 <inputs>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
20 <param label="SDF/MOL input" type="data" name="input" format="sdf,mol" argument="--input"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
21 <param label="Standardize" checked="false" type="boolean" name="standardize" argument="--standardize" truevalue="--standardize" falsevalue="" help="Apply the 'Standardize' pipeline component"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
22 <param label="Get parent" checked="false" type="boolean" name="get_parent" argument="--get_parent" truevalue="--get_parent" falsevalue="" help="Apply the 'GetParent' pipeline component"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
23 <param label="Check" checked="false" type="boolean" name="check" argument="--check" truevalue="--check" falsevalue="" help="Apply the 'Check' pipeline component"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
24 </inputs>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
25 <outputs>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
26 <data name="output" format="sdf" label="Processed molecules"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
27 </outputs>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
28 <tests>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
29 <test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
30 <param name="input" value="o_molblock.mol" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
31 <param name="standardize" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
32 <output name="output" value="std_molblock.mol"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
33 </test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
34 <test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
35 <param name="input" value="o_molblock.mol" ftype="mol" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
36 <param name="get_parent" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
37 <output name="output" value="parent_molblock.mol"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
38 </test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
39 <test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
40 <param name="input" value="o_molblock.mol" ftype="mol" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
41 <param name="check" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
42 <output name="output" value="check.mol"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
43 </test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
44 <test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
45 <param name="input" value="10mol.sdf" ftype="sdf" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
46 <param name="standardize" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
47 <param name="get_parent" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
48 <param name="check" value="true" />
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
49 <output name="output" value="pipeline_multi.sdf"/>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
50 </test>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
51 </tests>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
52 <help><![CDATA[
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
53
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
54 Apply the ChEMBL chemical curation pipeline to a set of chemical structures in SDF
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
55 format. The pipeline is described in detail in the citation provided (Bento et al.,
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
56 2020).
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
57
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
58 The pipeline consists of three components:
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
59 - a Standardizer which formats compounds according to defined rules and conventions, based mostly on FDA/IUPAC guidelines.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
60 - a GetParent component that removes any salts and solvents from the compound to create its parent.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
61 - a Checker to test the validity of chemical structures and flag any serious errors. Errors are given a code from 0 (least serious) to 10 (most serious), the highest of which is stored in the SDF field `<MaxPenaltyScore>`. A list of all errors encountered is recorded under `<IssueMessages>`.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
62
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
63 Either one or more of these protocols can be applied in a single Galaxy job.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
64
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
65 -----
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
66
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
67 .. class:: infomark
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
68
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
69 **Input**
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
70
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
71 One or more molecules in MOL/SDF format.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
72
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
73 -----
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
74
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
75 .. class:: infomark
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
76
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
77 **Output**
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
78
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
79 A MOL/SD-file containing the processed molecules.
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
80
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
81 ]]></help>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
82 <citations>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
83 <citation type="doi">10.1186/s13321-020-00456-1</citation>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
84 </citations>
2f59c6239f25 "planemo upload for repository https://github.com/chembl/chembl_webresource_client commit 78f2261af4e00c830ea311337d0aed9b297aad8e-dirty"
bgruening
parents:
diff changeset
85 </tool>