annotate recetox_xmsannotator_advanced.xml @ 1:1c70b19b09eb draft

"planemo upload commit e434c430917b52ef21b96f0231663c1f1dda34f9-dirty"
author recetox
date Thu, 17 Sep 2020 08:40:19 +0000
parents 7c452c71d960
children 7807fbeb1388
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
1c70b19b09eb "planemo upload commit e434c430917b52ef21b96f0231663c1f1dda34f9-dirty"
recetox
parents: 0
diff changeset
1 <tool id="recetox_xmsannotator_advanced" name="xmsannotator - advanced" version="v2.0">
0
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
2 <macros>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
3 <import>recetox_xmsannotator_macros.xml</import>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
4 </macros>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
5
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
6 <expand macro="requirements"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
7
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
9 #set expected_adducts = [f'"{$i.adduct}"' for $i in $annotation.expected_adducts]
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
10 #set expected_adducts = "c(" + ', '.join($annotation.expected_adducts) + ",)"
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
11
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
12 Rscript -e 'annotation <- xmsannotator::advanced_annotation(
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
13 data = arrow::read_feather("$peaks"),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
14 metabolite = rhdf5::h5read("$metabolites", "metabolites"),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
15 max_mz_diff = as.double($tolerances.max_mz_diff),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
16 max_rt_diff = as.double($tolerances.max_rt_diff),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
17 correlation_method = "$clustering.correlation_method",
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
18 correlation_threshold = as.double($clustering.correlation_threshold),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
19 min_cluster_size = as.integer($clustering.min_cluster_size),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
20 deep_split = as.integer($clustering.deep_split),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
21 network_type = "$clustering.network_type",
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
22 boost_metabolites = arrow::read_feather("$annotation.boost_metabolites"),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
23 expected_adducts = as.character($expected_adducts),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
24 min_isp = as.integer($annotation.min_isp),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
25 max_isp = as.integer($annotation.max_isp),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
26 strict_boosting = as.logical($annotation.strict_boosting),
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
27 redundancy_filtering = as.logical($annotation.redundancy_filtering)
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
28 )'
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
29 -e 'arrow::write_feather(annotation, "$annotation")'
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
30 ]]></command>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
31
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
32 <inputs>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
33 <expand macro="peaks"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
34 <expand macro="metabolites"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
35
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
36 <section name="tolerances" title="Tolerances" expanded="true">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
37 <param name="max_mz_diff" type="float" value="10" min="0" label="Mass tolerance [ppm]" help="Mass tolerance in ppm for database matching."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
38 <param name="max_rt_diff" type="float" value="10" min="0" label="Retention time tolerance [s]" help="Retention time tolerance in seconds for finding peaks derived from the same parent metabolite."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
39 </section>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
40
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
41 <section name="clustering" title="Clustering">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
42 <param name="correlation_method" type="select" display="radio" label="Correlation method">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
43 <option value="pearson" selected="true"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
44 <option value="spearman"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
45 </param>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
46 <param name="correlation_threshold" type="float" value="0.7" label="Correlation threshold" help="Correlation threshold between peaks to qualify as adducts/isotopes of the same metabolite."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
47 <param name="min_cluster_size" type="integer" value="10" min="1" label="Minimum cluster size" help="The minimum number of nodes to be considered as a cluster."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
48 <param name="deep_split" type="integer" value="2" min="0" max="4" label="Deep split" help="Deep split provides a rough control over sensitivity to cluster splitting. The higher the value, the more and smaller clusters will be produced (see WGCNA package documentation)."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
49 <param name="network_type" type="select" display="radio" label="Network type" help="Network type parameter affects how the network's adjacency matrix is created from the correlation matrix (see WGCNA package documentation).">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
50 <option value="signed"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
51 <option value="unsigned" selected="true"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
52 </param>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
53 </section>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
54
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
55 <section name="annotation" title="Annotation" expanded="true">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
56 <param name="boost_metabolites" type="data" format="csv" optional="true" label="Validated metabolites score boosting (optional)" help="Table of previously validated metabolites to boost their confidence scores. The 1st column of the table must contain IDs of metabolites. The optional 2nd and 3rd columns may contain mz values and retention times."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
57 <repeat name="expected_adducts" title="Expected adducts" help="Require the presence of certain adducts for a high confidence match.">
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
58 <param name="adduct" type="text" value="M+H" label="Adduct"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
59 </repeat>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
60 <param name="min_isp" type="integer" min="0" value="1" label="Minimum number of expected isotopes" help="Minimum number of adducts/isotopes to be present for a match to be considered as a high confidence match."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
61 <param name="max_isp" type="integer" min="0" value="5" label="Maximum number of expected isotopes" help="Maximum number of adducts/isotopes to be present for a match to be considered as a high confidence match."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
62 <param name="strict_boosting" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Strict boosting" help="Boost the scores of metabolites that not only belongs to the same pathway but also to the same cluster. Otherwise, do not account for cluster membership."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
63 <param name="redundancy_filtering" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Redundancy filtering" help="Whether to perform final redundancy filtering or not."/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
64 </section>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
65 </inputs>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
66
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
67 <outputs>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
68 <expand macro="annotation_output"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
69 </outputs>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
70
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
71 <help><![CDATA[]]></help>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
72 <expand macro="citations"/>
7c452c71d960 "planemo upload commit 5d3c80fb59c7d68a3d4ae26119821bc8d6fd65f2-dirty"
recetox
parents:
diff changeset
73 </tool>