annotate infer_experiment.xml @ 63:27e16a30667a draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
author iuc
date Tue, 09 Apr 2024 11:24:55 +0000
parents 5968573462fa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
1 <tool id="rseqc_infer_experiment" name="Infer Experiment" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@GALAXY_VERSION@">
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
2 <description>speculates how RNA-seq were configured</description>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
3 <macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
4 <import>rseqc_macros.xml</import>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
5 </macros>
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
6 <expand macro="bio_tools"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
7 <expand macro="requirements"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
8 <expand macro="stdio"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
9 <version_command><![CDATA[infer_experiment.py --version]]></version_command>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
10 <command><![CDATA[
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
11 @BAM_SAM_INPUTS@
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
12 infer_experiment.py -i 'input.${extension}' -r '${refgene}'
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
13 --sample-size ${sample_size}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
14 --mapq ${mapq}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
15 > '${output}'
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
16 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
17 </command>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
18 <inputs>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
19 <expand macro="bam_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
20 <expand macro="refgene_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
21 <expand macro="sample_size_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
22 <expand macro="mapq_param"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
23 </inputs>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
24 <outputs>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
25 <data format="txt" name="output" label="${tool.name} on ${on_string}: RNA-seq experiment configuration"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
26 </outputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
27 <tests>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
28 <test expect_num_outputs="1">
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
29 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 54
diff changeset
30 <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed" ftype="bed12"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
31 <output name="output" file="output.infer_experiment.txt"/>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
32 </test>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
33 </tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
34 <help><![CDATA[
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
35 infer_experiment.py
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
36 +++++++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
37
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
38 This program is used to speculate how RNA-seq sequencing were configured, especially how
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
39 reads were stranded for strand-specific RNA-seq data, through comparing reads' mapping
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
40 information to the underneath gene model.
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
41
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
42
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
43 Inputs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
44 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
46 Input BAM/SAM file
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
47 Alignment file in BAM/SAM format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
48
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
49 Reference gene model
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
50 Gene model in BED format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
51
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
52 Number of usable sampled reads (default=200000)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
53 Number of usable reads sampled from SAM/BAM file. More reads will give more accurate estimation, but make program little slower.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
54
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
55 Outputs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
56 +++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
57
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
58 For pair-end RNA-seq, there are two different
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
59 ways to strand reads (such as Illumina ScriptSeq protocol):
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
60
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
61 1. 1++,1--,2+-,2-+
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
62
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
63 * read1 mapped to '+' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
64 * read1 mapped to '-' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
65 * read2 mapped to '+' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
66 * read2 mapped to '-' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
67
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
68 2. 1+-,1-+,2++,2--
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
69
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
70 * read1 mapped to '+' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
71 * read1 mapped to '-' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
72 * read2 mapped to '+' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
73 * read2 mapped to '-' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
74
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
75 For single-end RNA-seq, there are also two different ways to strand reads:
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
76
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
77 1. ++,--
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
78
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
79 * read mapped to '+' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
80 * read mapped to '-' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
81
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
82 2. +-,-+
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
83
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
84 * read mapped to '+' strand indicates parental gene on '-' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
85 * read mapped to '-' strand indicates parental gene on '+' strand
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
86
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
87
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
88 Example Output
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
89 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
90
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
91 **Example1** ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
92
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
93 =========================================================
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
94 This is PairEnd Data ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
95
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
96 Fraction of reads explained by "1++,1--,2+-,2-+": 0.4992
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
97 Fraction of reads explained by "1+-,1-+,2++,2--": 0.5008
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
98 Fraction of reads explained by other combinations: 0.0000
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
99 =========================================================
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
100
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
101 *Conclusion*: We can infer that this is NOT a strand specific because 50% of reads can be explained by "1++,1--,2+-,2-+", while the other 50% can be explained by "1+-,1-+,2++,2--".
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
102
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
103 **Example2** ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
104
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
105 ============================================================
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
106 This is PairEnd Data
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
107
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
108 Fraction of reads explained by "1++,1--,2+-,2-+": 0.9644 ::
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
109 Fraction of reads explained by "1+-,1-+,2++,2--": 0.0356
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
110 Fraction of reads explained by other combinations: 0.0000
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
111 ============================================================
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
112
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
113 *Conclusion*: We can infer that this is a strand-specific RNA-seq data. strandness of read1 is consistent with that of gene model, while strandness of read2 is opposite to the strand of reference gene model.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
114
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
115 **Example3** ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
116
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
117 =========================================================
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
118 This is SingleEnd Data ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
119
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
120 Fraction of reads explained by "++,--": 0.9840 ::
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
121 Fraction of reads explained by "+-,-+": 0.0160
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
122 Fraction of reads explained by other combinations: 0.0000
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
123 =========================================================
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
124
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
125 *Conclusion*: This is single-end, strand specific RNA-seq data. Strandness of reads are concordant with strandness of reference gene.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
126
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
127 @ABOUT@
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
128
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
129 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
130 </help>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
131 <expand macro="citations"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
132 </tool>