Mercurial > repos > jjohnson > arriba
comparison macros.xml @ 7:25d207f7ff83 draft
"planemo upload for repository https://github.com/jj-umn/tools-iuc/tree/arriba/tools/arriba commit e113a79cc67e0bdb168babfe964f34873b2e1303"
author | jjohnson |
---|---|
date | Mon, 11 Oct 2021 16:40:51 +0000 |
parents | 5ebf2354cc9b |
children | 8c4c97fd0555 |
comparison
equal
deleted
inserted
replaced
6:7253b367c082 | 7:25d207f7ff83 |
---|---|
1 <macros> | 1 <macros> |
2 <token name="@TOOL_VERSION@">2.1.0</token> | 2 <token name="@TOOL_VERSION@">2.1.0</token> |
3 <token name="@VERSION_SUFFIX@">0</token> | 3 <token name="@VERSION_SUFFIX@">0</token> |
4 dd | |
5 <xml name="requirements"> | 4 <xml name="requirements"> |
6 <requirements> | 5 <requirements> |
7 <requirement type="package" version="@TOOL_VERSION@">arriba</requirement> | 6 <requirement type="package" version="@TOOL_VERSION@">arriba</requirement> |
8 <yield/> | 7 <yield/> |
9 </requirements> | 8 </requirements> |
15 </citations> | 14 </citations> |
16 </xml> | 15 </xml> |
17 <xml name="version_command"> | 16 <xml name="version_command"> |
18 <version_command>arriba -h | grep Version | sed 's/^.* //'</version_command> | 17 <version_command>arriba -h | grep Version | sed 's/^.* //'</version_command> |
19 </xml> | 18 </xml> |
19 <xml name="visualization_options"> | |
20 <param name="cytobands" argument="--cytobands" type="data" format="tabular" optional="true" label="Cytobands"/> | |
21 <section name="options" expanded="false" title="Draw Fusion Options"> | |
22 <param argument="--transcriptSelection" type="select" optional="true" label="Transcript selection"> | |
23 <help>By default the transcript isoform with the highest coverage is drawn. | |
24 Alternatively, the transcript isoform that is provided in the columns | |
25 transcript_id1 and transcript_id2 in the given fusions file can be drawn. | |
26 Selecting the isoform with the highest coverage usually produces nicer plots, | |
27 in the sense that the coverage track is smooth and shows a visible increase in coverage after the fusion breakpoint. | |
28 However, the isoform with the highest coverage may not be the one that is involved in the fusion. | |
29 Often, genomic rearrangements lead to non-canonical isoforms being transcribed. | |
30 For this reason, it can make sense to rely on the transcript selection provided by the columns transcript_id1/2, | |
31 which reflect the actual isoforms involved in a fusion. | |
32 \ As a third option, the transcripts that are annotated as canonical can be drawn. | |
33 Transcript isoforms tagged with appris_principal, appris_candidate, or CCDS are considered canonical. | |
34 </help> | |
35 <option value="coverage">coverage</option> | |
36 <option value="provided">provided</option> | |
37 <option value="canonical">canonical</option> | |
38 </param> | |
39 <param argument="--minConfidenceForCircosPlot" type="select" optional="true" label="Transcript selection"> | |
40 <help>The fusion of interest is drawn as a solid line in the circos plot. | |
41 To give an impression of the overall degree of rearrangement, | |
42 all other fusions are drawn as semi-transparent lines in the background. | |
43 This option determines which other fusions should be included in the circos plot. | |
44 Values specify the minimum confidence a fusion must have to be included. | |
45 It usually makes no sense to include low-confidence fusions in circos plots, | |
46 because they are abundant and unreliable, and would clutter up the circos plot. | |
47 Default: medium | |
48 </help> | |
49 <option value="none">none - only the fusion of interest is drawn</option> | |
50 <option value="low">low</option> | |
51 <option value="medium">medium</option> | |
52 <option value="high">high</option> | |
53 </param> | |
54 <param argument="--showIntergenicVicinity" type="integer" value="" min="0" optional="true" label="Intergenic Vicinity"> | |
55 <help>This option only applies to intergenic breakpoints. | |
56 If it is set to a value greater than 0, then the script draws the genes | |
57 which are no more than the given distance away from an intergenic breakpoint. | |
58 Note that this option is incompatible with squishIntrons. | |
59 Default: 0 | |
60 </help> | |
61 </param> | |
62 <param argument="--squishIntrons" type="select" optional="true" label="Squish introns"> | |
63 <help>Exons usually make up only a small fraction of a gene. | |
64 They may be hard to see in the plot. i | |
65 Since introns are in most situations of no interest in the context of gene fusions, | |
66 this switch can be used to shrink the size of introns to a fixed, negligible size. | |
67 It makes sense to disable this feature, if breakpoints in introns are of importance. | |
68 Default: TRUE | |
69 </help> | |
70 <option value="TRUE">True</option> | |
71 <option value="FALSE">False</option> | |
72 </param> | |
73 | |
74 <param argument="--mergeDomainsOverlappingBy" type="float" value="" min="0." max="1.0" optional="true" label="Merge Domains Overlapping By"> | |
75 <help>Occasionally, domains are annotated redundantly. | |
76 For example, tyrosine kinase domains are frequently annotated as | |
77 Protein tyrosine kinase and Protein kinase domain. | |
78 In order to simplify the visualization, such domains can be merged into one, | |
79 given that they overlap by the given fraction. | |
80 The description of the larger domain is used. | |
81 Default: 0.9 | |
82 </help> | |
83 </param> | |
84 <param argument="--printExonLabels" type="select" optional="true" label="Print Exon Labels"> | |
85 <help>By default the number of an exon is printed inside each exon, | |
86 which is taken from the attribute exon_number of the GTF annotation. | |
87 When a gene has many exons, the boxes may be too narrow to contain the labels, | |
88 resulting in unreadable exon labels. In these situations, i | |
89 it may be better to turn off exon labels. | |
90 Default: TRUE | |
91 </help> | |
92 <option value="TRUE">True</option> | |
93 <option value="FALSE">False</option> | |
94 </param> | |
95 <param argument="--render3dEffect" type="select" optional="true" label="Render 3D effect"> | |
96 <help>Whether light and shadow should be rendered to give objects a 3D effect. | |
97 Default: TRUE | |
98 </help> | |
99 <option value="TRUE">True</option> | |
100 <option value="FALSE">False</option> | |
101 </param> | |
102 <param argument="--optimizeDomainColors" type="select" optional="true" label="Optimize Domain Colors"> | |
103 <help>By default, the script colorizes domains according to the colors | |
104 specified in the file given in --annotation. | |
105 This way, coloring of domains is consistent across all proteins. | |
106 But since there are more distinct domains than colors, | |
107 this can lead to different domains having the same color. | |
108 If this option is set to TRUE, the colors are recomputed for each fusion separately. | |
109 This ensures that the colors have the maximum distance for each individual fusion, | |
110 but they are no longer consistent across different fusions. | |
111 Default: FALSE | |
112 </help> | |
113 <option value="TRUE">True</option> | |
114 <option value="FALSE">False</option> | |
115 </param> | |
116 <param argument="--color1" type="color" value="" optional="true" label="Color of the 5' end of the fusion."/> | |
117 <param argument="--color2" type="color" value="" optional="true" label="Color of the 3' end of the fusion."/> | |
118 <param argument="--pdfWidth" type="float" value="" min="1." optional="true" label="Width of PDF output file in inches" | |
119 help="Default: 11.692"/> | |
120 <param argument="--pdfHeight" type="float" value="" min="1." optional="true" label="Height of PDF output file in inches" | |
121 help="Default: 8.267"/> | |
122 <param argument="--fontSize" type="float" value="" min="0." optional="true" label="Scale the size of text" | |
123 help="Default: 1.0"/> | |
124 </section> | |
125 </xml> | |
126 <token name="@DRAW_FUSIONS@"> | |
127 draw_fusions.R | |
128 --fusions='$fusions' | |
129 --alignments='Aligned.sortedByCoord.out.bam' | |
130 --annotation='$annotation' | |
131 --output=fusions.pdf | |
132 #if $visualization.cytobands | |
133 --cytobands='$visualization.cytobands' | |
134 #end if | |
135 #if $protein_domains | |
136 --proteinDomains='$protein_domains' | |
137 #end if | |
138 ## Visualization Options | |
139 #if $visualization.options.transcriptSelection | |
140 --transcriptSelection=$visualization.options.transcriptSelection | |
141 #end if | |
142 #if $visualization.options.minConfidenceForCircosPlot | |
143 --minConfidenceForCircosPlot=$visualization.options.minConfidenceForCircosPlot | |
144 #end if | |
145 #if $visualization.options.showIntergenicVicinity | |
146 --showIntergenicVicinity=$visualization.options.showIntergenicVicinity | |
147 #end if | |
148 #if $visualization.options.squishIntrons | |
149 --squishIntrons=$visualization.options.squishIntrons | |
150 #end if | |
151 #if $visualization.options.mergeDomainsOverlappingBy | |
152 --mergeDomainsOverlappingBy=$visualization.options.mergeDomainsOverlappingBy | |
153 #end if | |
154 #if $visualization.options.printExonLabels | |
155 --printExonLabels=$visualization.options.printExonLabels | |
156 #end if | |
157 #if $visualization.options.render3dEffect | |
158 --render3dEffect=$visualization.options.render3dEffect | |
159 #end if | |
160 #if $visualization.options.optimizeDomainColors | |
161 --optimizeDomainColors=$visualization.options.optimizeDomainColors | |
162 #end if | |
163 #if $visualization.options.color1 | |
164 --color1=$visualization.options.color1 | |
165 #end if | |
166 #if $visualization.options.color2 | |
167 --color2=$visualization.options.color2 | |
168 #end if | |
169 #if $visualization.options.pdfWidth | |
170 --pdfWidth=$visualization.options.pdfWidth | |
171 #end if | |
172 #if $visualization.options.pdfHeight | |
173 --pdfHeight=$visualization.options.pdfHeight | |
174 #end if | |
175 #if $visualization.options.fontSize | |
176 --fontSize=$visualization.options.fontSize | |
177 #end if | |
178 </token> | |
20 </macros> | 179 </macros> |