Mercurial > repos > wolma > mimodd_main

comparison varreport.xml @ 0:f0f2795de2c7 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit 528bcf3b769c7c73f119b2a176d19071f9ef5312
author wolma
date Tue, 19 Dec 2017 04:54:04 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0f2795de2c7
1 <tool id="mimodd_varreport" name="MiModD Report Variants"
2 version="@MIMODD_WRAPPER_VERSION@">
3 <description>
4 in a human-friendly format that simplifies data exploration
5 </description>
6 <macros>
7 <import>macros.xml</import>
8 </macros>
9 <expand macro="requirements" />
10 <expand macro="stdio" />
11 <expand macro="version_command" />
12 <command><![CDATA[
13 #if $str($formatting.oformat) == 'html':
14 mkdir '$ofile.files_path' &&
15 #end if
16 mimodd varreport
17 '$inputfile' --oformat ${formatting.oformat}
18 #if $str($formatting.oformat) == 'html':
19 #if $str($formatting.species):
20 --species '${formatting.species}'
21 #end if
22 #if $formatting.link_formatter:
23 --link '${formatting.link_formatter}'
24 #end if
25 --ofile '${ofile.files_path}/variant_report.html'
26 && echo
27 '<html><body><p>MiModD has generated the variant report you requested, but for technical reasons, we have to take you through this little detour to display the report in Galaxy.</p><p>Proceed to <a href="variant_report.html">the variant report</a>.</p></body></html>'
28 > '$ofile'
29 #else
30 --ofile '$ofile'
31 #end if
32 ]]></command>
33
34 <inputs>
35 <param name="inputfile" type="data" format="vcf"
36 label="The VCF input with the variants to be reported" />
37 <conditional name="formatting">
38 <param name="oformat" type="select"
39 label="Format to use for the report">
40 <option value="html">HTML</option>
41 <option value="text">Tab-separated plain text</option>
42 </param>
43 <when value="html">
44 <param name="species" type="text" label="Species"
45 help="If you declare the species your input data comes from, variant reports in html format can have hyperlinks to species-specific databases and genome browsers added. If you have used the MiModD Variant Annotation tool to generate the input dataset, the species information will already be recorded in the dataset, but you can overwrite it if you wish.">
46 <expand macro="lex_sam_header" message="Non-ASCII characters are not allowed in species names." />
47 </param>
48 <param name="link_formatter" type="data" format="txt" optional="true"
49 label="Optional file with species-specific hyperlink formatting instructions"
50 help="If the tool has no built-in support for your species, i.e., it does not know how to generate hyperlinks for it, you can provide a custom recipe here." />
51 </when>
52 <when value="text">
53 <param name="species" type="hidden" value="" />
54 </when>
55 </conditional>
56 </inputs>
57
58 <outputs>
59 <data name="ofile" format="html">
60 <change_format>
61 <when input="formatting.oformat" value="text" format="tabular"/>
62 </change_format>
63 </data>
64 </outputs>
65
66 <tests>
67 <test>
68 <param name="inputfile" value="a.vcf" />
69 <conditional name="formatting">
70 <param name="oformat" value="html" />
71 <param name="species" value="C. elegans" />
72 </conditional>
73 <output name="ofile" ftype="html">
74 <extra_files type="file" name="variant_report.html" ftype="html">
75 <assert_contents>
76 <has_line_matching expression=".+tools/genome/gbrowse/c_elegans_PRJNA13758.+" />
77 </assert_contents>
78 </extra_files>
79 </output>
80 </test>
81 <test>
82 <param name="inputfile" value="a.vcf" />
83 <conditional name="formatting">
84 <param name="oformat" value="text" />
85 </conditional>
86 <output name="ofile" ftype="tabular">
87 <assert_contents>
88 <has_n_columns n="11" />
89 <has_line_matching expression="Chromosome&#009;Position&#009;Affected Gene&#009;Transcript&#009;Effects&#009;genotype N2&#009;.+genotype ot266&#009;.+" />
90 <has_line_matching expression="chrI&#009;.+" />
91 </assert_contents>
92 </output>
93 </test>
94 </tests>
95
96 <help><![CDATA[
97 .. class:: infomark
98
99 **What it does**
100
101 The tool turns a variant list in VCF format into a more readable summary table
102 listing variant sites and effects.
103
104
105 **Html output enriched with species-specific hyperlinks**
106
107 If you select html as the output format, the tool can insert species- and
108 variant-specific hyperlinks to public genome browsers and databases into the
109 report. This is a useful feature to explore medium-size lists of variants, but
110 requires that the tool knows:
111
112 1) the species that you are analyzing data for
113
114 The tool can autodetect the species if the input dataset has been generated
115 with the *MiModD Variant Annotation* tool. Alternatively, you can declare
116 the species you are working with explicitly.
117
118 2) how to generate hyperlinks for this species
119
120 The tool has built-in support for a number of standard model organisms.
121 If your organism is not in that list or if you find that the default
122 hyperlinks for a supported species are outdated, you can provide your own
123 recipe to generate correct hyperlinks through a `custom hyperlink template
124 file`_.
125
126 **TIP:**
127 MiModD's built-in hyperlink formatting tables are actively maintained and
128 extended with every new version! If you find the tool produces outdated
129 hyperlinks for any supported species or if you would like to see additional
130 species supported, do not hesitate to `tell us about it`_.
131 If you have a custom hyperlink template file that is working for you, that
132 is even better. We may use it as a starting point for a built-in recipe and,
133 while we are working on that and with your permission, we can post it on the
134 package home page for other users who may need it.
135
136 .. _custom hyperlink template file: http://mimodd.readthedocs.io/en/@MIMODD_REAL_VERSION@/recipes.html#hyperlink-template-file
137 .. _tell us about it: mailto:mimodd@googlegroups.com
138
139 @HELP_FOOTER@
140 ]]></help>
141 <expand macro="citations" />
142 </tool>