annotate varreport.xml @ 1:1425ea794026 draft default tip

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