annotate isoread.xml @ 43:1c51f04fc951 draft

Uploaded
author glogobyte
date Mon, 06 Dec 2021 15:17:05 +0000
parents a1f3a63218cb
children 24839b38543d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
1
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
2 <tool id="IsoRead" name="IsoRead: miR and isomiR identification and classification" version="0.1.0">
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
3 <requirements>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
4 <requirement type="package" version="1.7">fpdf</requirement>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
5 <requirement type="package" version="0.8">logomaker</requirement>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
6 <requirement type="package" version="3.7.4">python</requirement>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
7 <requirement type="package" version="1.17.3">numpy</requirement>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
8 <requirement type="package" version="3.1.2">matplotlib</requirement>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
9 <requirement type="package" version="1.0.3">pandas</requirement>
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
10 </requirements>
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
11 <command>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
12 #set controls=[]
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
13 #for $input in $control#
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
14 $controls.extend([str($input.element_identifier),str($input)])
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
15 #end for#
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
16 #set treateds=[]
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
17 #for $input in $treated#
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
18 $treateds.extend([str($input.element_identifier),str($input)])
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
19 #end for#
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
20 #if $mir_input.database == "1":
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
21 #if $f.fil == "1":
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
22 #set path=$mir_input.genome1.fields.path
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
23 python -W ignore $__tool_directory__/mirbase_opt.py -con $controls -tre $treateds -analysis $analysis -tool_dir $__tool_directory__ -gen "$path" -f "$mir_input.database" -percentage "-1" -counts "-1" -name1 "$fal1" -name2 "$fal2"
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
24 #end if
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
25 #if $f.fil == "2":
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
26 #set path=$mir_input.genome1.fields.path
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
27 python -W ignore $__tool_directory__/mirbase_opt.py -con $controls -tre $treateds -analysis $analysis -tool_dir $__tool_directory__ -gen "$path" -f "$mir_input.database" -percentage "$f.fil1" -counts "$f.fil2" -name1 "$fal1" -name2 "$fal2"
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
28 #end if
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
29 #else:
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
30 #if $f.fil == "1":
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
31 #set path=$mir_input.genome2.fields.value
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
32 python -W ignore $__tool_directory__/mirgene_with_new_names.py -con $controls -tre $treateds -analysis $analysis -tool_dir $__tool_directory__ -gen "$path" -f "$mir_input.database" -percentage "-1" -counts "-1" -name1 "$fal1" -name2 "$fal2"
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
33 #end if
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
34 #if $f.fil == "2":
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
35 #set path=$mir_input.genome2.fields.value
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
36 python -W ignore $__tool_directory__/mirgene_with_new_names.py -con $controls -tre $treateds -analysis $analysis -tool_dir $__tool_directory__ -gen "$path" -f "$mir_input.database" -percentage "$f.fil1" -counts "$f.fil2" -name1 "$fal1" -name2 "$fal2"
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
37 #end if
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
38 #end if
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
39
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
40 </command>
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
41 <inputs>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
42 <param name="analysis" type="select" label="Discover miR with templated or/and non-templated isomiRs" help="Choose the category of miRNAs for detection">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
43 <option value="1" selected="true">Detection of only templated miRNAs</option>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
44 <option value="2">Detection of templated and non-templated miRNAs</option>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
45 </param>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
46 <conditional name="mir_input">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
47 <param name="database" type="select" label="Reference miRNA DB" help="Choose which database prefer to be used.">
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
48 <option value="1" selected="true">MirBase</option>
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
49 <option value="2">MirGene</option>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
50 </param>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
51 <when value="1">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
52 <param name="genome1" type="select" label="Reference miRNAs (organism)" help="If your genome coordinates of interest are not listed, contact the Galaxy team">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
53 <options from_data_table="mirbase" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
54 </param>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
55 </when>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
56 <when value="2">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
57 <param name="genome2" type="select" label="Reference miRNAs (organism)" help="If your genome coordinates of interest are not listed, contact the Galaxy team">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
58 <options from_data_table="mirgene" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
59 </param>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
60 </when>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
61 </conditional>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
62 <param name="fal1" type="text" value="FactorLevel" label="Specify a factor level, typical values could be 'tumor', 'normal', 'treated' or 'control'"/>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
63 <param name="control" format="sam" type="data" multiple="True" label="Select BAM files of the factor level samples" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
64 <param name="fal2" type="text" value="FactorLevel" label="Specify a factor level, typical values could be 'tumor', 'normal', 'treated' or 'control'"/>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
65 <param name="treated" format="sam" type="data" multiple="True" label="Select BAM files of the factor level samples" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
66 <conditional name="f">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
67 <param name="fil" type="select" label="Filter low counts" help="Treat genes with very low expression as unexpressed and filter out">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
68 <option value="1" selected="true">No</option>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
69 <option value="2">Yes</option>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
70 </param>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
71 <when value="2">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
72 <param name="fil1" type="integer" value="0" label="Minimum percentage of the samples" help="Filter out all genes that do not meet the Minimum counts in at least this many samples of every category"/>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
73 <param name="fil2" type="integer" value="0" label="Minimum counts" help="Filter out all genes that do not meet this minimum count"/>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
74 </when>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
75 <when value="1">
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
76 </when>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
77 </conditional>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
78 <param name="db" type="boolean" checked="true" truevalue="1" falsevalue="0" label="Output Database files" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
79 <param name="cmatrix" type="boolean" checked="false" truevalue="1" falsevalue="0" label="Output Matrix files, one for each factor level" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
80 <param name="c_files" type="boolean" checked="true" truevalue="1" falsevalue="0" label="Output Count tables, one for each sample" />
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
81 </inputs>
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
82 <outputs>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
83 <collection name="list_output1" type="list" label="Database ${fal1} templated" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
84 <discover_datasets pattern="__name__" format="tabular" directory="split1" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
85 <filter>db == 1 and (analysis == "1" or analysis == "2")</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
86 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
87 <collection name="list_output2" type="list" label="Database ${fal2} templated" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
88 <discover_datasets pattern="__name__" format="tabular" directory="split2" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
89 <filter>db == 1 and (analysis == "1" or analysis == "2")</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
90 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
91 <collection name="list_output3" type="list" label="Database ${fal1} non-templated" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
92 <discover_datasets pattern="__name__" format="tabular" directory="split3" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
93 <filter>db == 1 and analysis == "2"</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
94 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
95 <collection name="list_output4" type="list" label="Database ${fal2} non-templated" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
96 <discover_datasets pattern="__name__" format="tabular" directory="split4" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
97 <filter>db == 1 and analysis == "2"</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
98 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
99
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
100 <collection name="Counts" type="list" label="Count Matrices" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
101 <discover_datasets pattern="__name__" format="tabular" directory="Counts" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
102 <filter>cmatrix==1</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
103 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
104 <collection name="list_output9" type="list" label="Count files ${fal1} for Differential Expression" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
105 <discover_datasets pattern="__name__" format="tabular" directory="Diff/temp_con" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
106 <filter>c_files==1 and (analysis == "1")</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
107 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
108 <collection name="list_output10" type="list" label="Count files ${fal2} for Differential Expression" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
109 <discover_datasets pattern="__name__" format="tabular" directory="Diff/temp_tre" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
110 <filter>c_files==1 and (analysis == "1")</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
111 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
112 <collection name="list_output11" type="list" label="Count files ${fal1} for Differential Expression" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
113 <discover_datasets pattern="__name__" format="tabular" directory="Diff/n_temp_con" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
114 <filter>c_files==1 and analysis == "2"</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
115 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
116 <collection name="list_output12" type="list" label="Count files ${fal2} for Differential Expression" >
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
117 <discover_datasets pattern="__name__" format="tabular" directory="Diff/n_temp_tre" />
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
118 <filter>c_files==1 and analysis == "2"</filter>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
119 </collection>
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
120
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
121 <data name="Results non templated treated1" format="pdf" label="IsomiR Profile Report" from_work_dir="$__tool_directory__/report1.pdf" />
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
122 </outputs>
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
123 <help><![CDATA[
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
124 **Inputs**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
125
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
126 IsoRead takes SAM files from alignment tool and RefSeq miRNA sequences from miRbase or miRGene as input. It discovers and classifies miRs and their isoforms in two main types—templated isomiRs (_t) and non-templated isomiRs (_nont) across samples. The coordinates in the name extension show the sequence offset relative to the RefSeq sequence.
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
127
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
128 **Examples**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
129
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
130 ============================= ========================
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
131 **RefSeq miRNA** **Sequence**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
132 ----------------------------- ------------------------
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
133 hsa-let-7c-5p_chr21(+) TGAGGTAGTAGGTTGTATGGTT
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
134 **Templated miRNA** **Sequence**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
135 hsa-let-7c-5p_chr21(+)_t_0_-1 TGAGGTAGTAGGTTGTATGGT
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
136 **Non Templated miRNA** **Sequence**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
137 hsa-let-7c-5p_nont_0_+2_AT TGAGGTAGTAGGTTGTATGGTTAT
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
138 ============================= ========================
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
139
43
1c51f04fc951 Uploaded
glogobyte
parents: 42
diff changeset
140 -----
1c51f04fc951 Uploaded
glogobyte
parents: 42
diff changeset
141
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
142 **Outputs**
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
143
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
144 As output, the tool produces tabular files with all the detected miRs and isomiRs per category for every SAM file as a database for the user and two types of count matrices containing the copy number of each entry. One of the count matrix types is compatible with the DESeq2 and EdgeR tools so that the user can continue with differential expression analysis. The other types of count matrices generated per miR category (RefSeq miRs, template isomiRs, and non-template isomiRs) and per group are enriched with read sequences. Apart from the tabular files, the tool produces a PDF report file with several custom graphs and statistical information about the isomiR profiles in the user data.
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
145
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
146 **Examples**
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
147
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
148 Database file
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
149
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
150 .. image:: isoread.png
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
151
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
152 Count matrix enriched with read sequences
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
153
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
154 =============================== ====================== =========== ===========
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
155 **Name** **Sequence** **Sample1** **Sample2**
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
156 ------------------------------- ---------------------- ----------- -----------
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
157 hsa-miR-320a-3p_chr8(-) AAAAGCTGGGTTGAGAGGGCGA 260 609
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
158 hsa-miR-320a-3p_chr8(-)_t_+1_+1 AAAGCTGGGTTGAGAGGGCGAA 192 30
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
159 =============================== ====================== =========== ===========
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
160
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
161
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
162
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
163 ]]></help>
42
a1f3a63218cb Uploaded
glogobyte
parents: 36
diff changeset
164 <citations>
a1f3a63218cb Uploaded
glogobyte
parents: 36
diff changeset
165 <citation type="doi">10.3390/cancers13225663</citation>
a1f3a63218cb Uploaded
glogobyte
parents: 36
diff changeset
166 </citations>
34
bb3a4324ecd0 Uploaded
glogobyte
parents:
diff changeset
167 </tool>
36
69f028256fca Uploaded
glogobyte
parents: 34
diff changeset
168