annotate MetaRNAseq.xml @ 39:07ac07715f22 draft default tip

planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 7026b0fbe3611962c37c7f9b5f001434f059e32c
author sblanck
date Tue, 26 Jun 2018 04:14:25 -0400
parents 25b828010ca9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28
49ce6fbe11de planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit cb90fdea2a64908e301355aef89de403e107764d
sblanck
parents: 21
diff changeset
1 <tool id="metarnaseq" name="RNA-seq data meta-analysis" version="1.1.0">
9
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
2
16
161fe6ba75d7 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 7161f59bef78b3674be55213a29fb2d10686849f-dirty
sblanck
parents: 15
diff changeset
3 <description>Performs meta-analysis thanks to metaRNAseq</description>
9
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
4
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
5 <requirements>
17
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
6 <requirement type="package">bioconductor-affy</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
7 <requirement type="package">bioconductor-annaffy</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
8 <requirement type="package">bioconductor-geoquery</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
9 <requirement type="package">r-venndiagram</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
10 <requirement type="package">r-jsonlite</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
11 <requirement type="package">r-metarnaseq</requirement>
ef7d98f9eb51 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit f981b0fd5431199f51e2db8c680eb3d2d1d741b6
sblanck
parents: 16
diff changeset
12 <requirement type="package">r-optparse</requirement>
28
49ce6fbe11de planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit cb90fdea2a64908e301355aef89de403e107764d
sblanck
parents: 21
diff changeset
13 <requirement type="package" version="1.3.3">r-upsetr</requirement>
9
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
14 </requirements>
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
15
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
16 <stdio>
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
17 <exit_code range="1:" />
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
18 <regex match="Warning" source="both" level="warning"/>
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
19 </stdio>
328f4031e5d3 planemo upload commit f882a5ba78afeb368605beb3986936e86c485cbb-dirty
sblanck
parents: 8
diff changeset
20
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
21 <command>
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
22
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
23 <![CDATA[
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
24 Rscript
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
25 ${__tool_directory__}/MetaRNASeq.R
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
26 --input "#for $s in $studies:
35
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
27 ${s.input};
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
28 #end for
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
29 "
35
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
30 --inputName "#for $s in $studies:
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
31 ${s.input.name};
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
32 #end for
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
33 "
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
34 --nbreplicates "#for $s in $studies:
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
35 ${s.nbreplicates};
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
36 #end for
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
37 "
a99bbda3cf1f planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit e956e308e78c1c2d2c5ac7420621527f0d4dad28
sblanck
parents: 34
diff changeset
38
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
39 --fdr $fdr
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
40 --result $top_table
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
41 --htmloutput $result_html
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
42 --htmloutputpath $result_html.extra_files_path
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
43 --htmltemplate ${__tool_directory__}/MetaRNASeq_tpl.html
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
44 ]]>
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
45
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
46 </command>
2
93451f832736 Uploaded
sblanck
parents:
diff changeset
47
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
48 <inputs>
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
49 <repeat name="studies" title="Study results" min="2" default="2" help="DESeq2 Result file and number of replicate of the study">
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
50 <param format="tabular" name="input" multiple="false" type="data" optional="false" label="DESeq2 result file" help="Must have the same number of row in each study"/>
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
51 <param name="nbreplicates" type="integer" value="10" label="Number of replicates" help="Number of replicates of the study"/>
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
52 </repeat>
33
2d7595c8041d planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit d42088af604c5a01e1ccebba1d59f7a28a976f71
sblanck
parents: 29
diff changeset
53 <param name="fdr" type="float" value="0.05" label="FDR" min="0" max="1" help="Adjusted p-value threshold to be declared differentially expressed"/>
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
54 </inputs>
2
93451f832736 Uploaded
sblanck
parents:
diff changeset
55
29
102e4ef8fed2 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 808ffb34e11a74cd2396e32868ea56f7ce8d83ff
sblanck
parents: 28
diff changeset
56
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
57 <outputs>
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
58 <data format="tabular" name="top_table" label="Summary of meta-analysis and single studie analysis from ${tool.name} on ${on_string}"/>
21
f953fdee364c planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit ecb5d3451f1623e0cc649ac5197e66995ce19eef-dirty
sblanck
parents: 17
diff changeset
59 <data format="html" name="result_html" label="Charts for ${tool.name} on ${on_string}"/>
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
60 </outputs>
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
61
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
62 <tests>
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
63
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
64 </tests>
2
93451f832736 Uploaded
sblanck
parents:
diff changeset
65
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
66 <help>
36
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
67 <![CDATA[
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
68 **What it does**
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
69
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
70 Given several DESeq2 results this tool runs a meta-analysis using the metaRNAseq R package.
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
71
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
72 **Inputs**
37
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
73 - At least 2 studies, and for each study
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
74 - Results of DESeq2 study
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
75 - Number of replicates of the study
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
76 - A FDR Threshold for a gene to be declared differentially expressed
36
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
77
37
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
78
36
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
79 **Results**
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
80
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
81 - Venn Diagram or upsetR diagram (when the number of studies is greater than 2) summarizing the results of the meta-analysis
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
82 - A list of indicators to evaluate the quality of the performance of the meta-analysis
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
83
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
84 - DE : Number of differentially expressed genes
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
85 - IDD (Integration Driven discoveries) : number of genes that are declared differentially expressed in the meta-analysis that were not identified in any of the single studies alone
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
86 - Loss : Number of genes that are identified differentially expressed in single studies but not in meta-analysis
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
87 - DR (Integration-driven Discovery Rate) : corresponding proportion of IDD
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
88 - IRR (Integration-driven Revision) : corresponding proportion of Loss
37
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
89
25b828010ca9 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit bfd179bd7fb4796e21183e0e4de2fcf78ca35b7d
sblanck
parents: 36
diff changeset
90 It also generates a text file containing summarization of the results of each single analysis and meta-analysis. Potential conflicts between single analyses are indicated by zero values in the "signFC" column.
36
22e1325aaa88 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit 0d3497e4f84869670647f7a6ffceca64469a4c00
sblanck
parents: 35
diff changeset
91 ]]>
14
e5a94bc69bd6 planemo upload for repository https://github.com/sblanck/smagexp/tree/master/smagexp_tools commit da1436252b5db4e90c39c95140558f0f93544160
sblanck
parents: 9
diff changeset
92 </help>
2
93451f832736 Uploaded
sblanck
parents:
diff changeset
93
93451f832736 Uploaded
sblanck
parents:
diff changeset
94 </tool>