0
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
1 <tool id="riboseqr_triplet_periodicity" name="Triplet Periodicity"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
2 version="0.4.0">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
3 <description>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
4 (Step 2) Plot triplet periodicity for different read lengths.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
5 </description>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
6 <requirements>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
7 <requirement type="package" version="3.1.2">R</requirement>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
8 <requirement type="package" version="6.2">readline</requirement>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
9 <requirement type="package" version="2.3.10">rpy2</requirement>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
10 <requirement type="package" version="0.4.0">riboseqr_wrapper_deps</requirement>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
11 </requirements>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
12 <stdio>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
13 <exit_code range="1:" level="fatal" description="Error" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
14 </stdio>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
15 <command interpreter="python">riboseqr/triplet.py
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
16 --rdata_load "$rdata_load"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
17 --fasta_file "$fasta_file"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
18 --start_codons "$start_codons"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
19 --stop_codons "$stop_codons"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
20 --include_lengths "$include_lengths"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
21 --analyze_plot_lengths "$analyze_plot_lengths"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
22 --text_legend "$text_legend"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
23 --rdata_save "$rdata_save"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
24 --html_file "$html_file"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
25 --output_path "$html_file.files_path"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
26 </command>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
27 <inputs>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
28 <param name="rdata_load" type="data" format="rda"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
29 label="Select prepared riboSeqR input (R data file)"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
30 multiple="false" optional="false"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
31 help="<br><h4><font color="#666666">findCDS
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
32 parameters</font></h4>">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
33 <validator type="expression"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
34 message="Please check if the correct RDA file is selected">value.name == "Prepare riboSeqR input (R data file)"</validator>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
35 </param>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
36
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
37 <param format="fasta" name="fasta_file" type="data"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
38 label="Select FASTA file of the reference transcriptome"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
39 help="This Fasta file is used to find start (ATG) and
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
40 stop codons(TAG, TAA, TGA) in frame with one another. If no files
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
41 are listed, you will need to upload a FASTA file of the reference
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
42 transcriptome. Please note that the FASTA header of the transcriptome
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
43 sequences must match the sequence names from the SAM file.">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
44 <validator type="empty_field" message="Field requires a value"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
45 </param>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
46
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
47 <param name="start_codons" type="text" size="15" value="ATG"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
48 label="Start codon(s) to use"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
49 help="Default is ATG. Multiple values must be comma-separated.">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
50 <validator type="empty_field" message="Field requires a value"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
51 </param>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
52
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
53 <param name="stop_codons" type="text" size="15" value="TAG, TAA, TGA"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
54 label="Stop codon(s) to use"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
55 help="Default is TAG, TAA, TGA. Multiple values must be comma-separated.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
56 <h4><font color="#666666">frameCounting
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
57 parameters</font></h4>">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
58 <validator type="empty_field" message="Field requires a value"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
59 </param>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
60
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
61 <param name="include_lengths" type="text"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
62 label="Lengths of ribosome footprints
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
63 to be included"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
64 help="Here, you can specify the lengths of ribosome footprints to
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
65 be included in the riboData object. <br>For example 25:30.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
66 Range, semi-colon separated. <h4><font color="#666666">readingFrame
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
67 parameters</font></h4>" value="25:30"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
68
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
69 <param name="analyze_plot_lengths" type="text"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
70 label="Lengths of reads to be analysed for frame-shift, or to be plotted"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
71 help="[Optional] If omitted, all lengths will be plotted.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
72 <br>For example 26:30. Range, semi-colon separated.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
73 <h4><font color="#666666">plotFS
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
74 parameters</font></h4>" value="26:30"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
75
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
76 <param name="text_legend" type="text" size="30"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
77 value='Frame 0, Frame 1, Frame 2'
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
78 label="Text for legend used in the
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
79 plot" help="Comma-separated values."/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
80 </inputs>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
81 <outputs>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
82 <data format="rda" name="rdata_save"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
83 label="Triplet periodicity (R data file)"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
84 <data format="html" name="html_file"
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
85 label="Triplet periodicity (HTML report)"/>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
86 </outputs>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
87 <tests>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
88 <test>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
89 <param name="rdata_load" value="Prepare riboSeqR input (R data file)" ftype="rda" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
90 <param name="fasta_file" value="rsem_chlamy236_deNovo.transcripts.fa" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
91 <param name="include_lengths" value="25:30" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
92 <param name="analyze_plot_lengths" value="26:30" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
93 <output name="rdata_save" file="Triplet periodicity (R data file)" ftype="rda" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
94 <output name="html_file" file="Triplet_periodicity_(HTML_report).html">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
95 <extra_files type="file" name="Periodicity-plot.png" value="Periodicity-plot.png" ftype="png" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
96 <extra_files type="file" name="Periodicity-plot.pdf" value="Periodicity-plot.pdf" ftype="pdf" />
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
97 </output>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
98 </test>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
99 </tests>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
100 <help>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
101 Triplet Periodicity
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
102 -------------------
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
103 riboSeqR version: ``1.0.5``.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
104
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
105 This tool can be used to plot triplet periodicity for different read lengths.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
106 The inputs for this program are:
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
107
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
108 #. Prepare riboSeqR input (R data file) from the previous step.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
109 #. FASTA format file of the reference transcriptome.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
110
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
111 .. class:: infomark
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
112
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
113 Please note that the FASTA header of the transcriptome sequences must
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
114 match the sequence names from the SAM file.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
115
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
116 How to use?
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
117 -----------
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
118 Inputs
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
119 ......
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
120 Select prepared R data file from the previous step.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
121
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
122 Select FASTA format file of the reference transcriptome, review/change other
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
123 options if necessary and execute program.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
124
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
125 Outputs
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
126 .......
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
127 The following files will be generated on completion:
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
128
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
129 #. Triplet periodicity (HTML report)
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
130
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
131 A HTML file with results and links to other output files - triplet
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
132 periodicity plot (PDF) and R script used for the session.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
133
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
134 #. Triplet periodicity (R data file)
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
135
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
136 Used as input for the next step - *Metagene analysis*.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
137
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
138 riboSeqR functions used
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
139 .......................
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
140 ``findCDS``, ``frameCounting``, ``readingFrame`` and ``plotFS``.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
141
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
142 For detailed description of the functions and the options used, please consult
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
143 the riboSeqR documentation.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
144
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
145 Links
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
146 .....
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
147 `riboSeqR <http://bioconductor.org/packages/3.0/bioc/html/riboSeqR.html>`_.
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
148
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
149 </help>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
150 <citations>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
151 <citation type="bibtex">
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
152 @Manual{,
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
153 title = {riboSeqR: Analysis of sequencing data from ribosome
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
154 profiling experiments.},
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
155 author = {Thomas J. Hardcastle},
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
156 year = {2014},
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
157 note = {R package version 1.0.5},
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
158 }
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
159 </citation>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
160 </citations>
|
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff
changeset
|
161 </tool>
|