annotate snpeff_get_chr_names.xml @ 33:94653948fdb9 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
author iuc
date Sat, 04 Oct 2025 17:00:46 +0000
parents ebe9fd7e5bd1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
ebe9fd7e5bd1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 280d5247becaa9a70db9c5c4a2f1fc50d302838a
iuc
parents: 31
diff changeset
1 <tool id="snpEff_get_chr_names" name="SnpEff chromosome-info:" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.0">
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
2 <description>list chromosome names/lengths</description>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
3 <macros>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
4 <import>snpEff_macros.xml</import>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
5 </macros>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
6 <requirements>
27
c6422110bc0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 67da1a478db26ad45f36a673218d526f8962d72f"
iuc
parents: 24
diff changeset
7 <expand macro="requirement">
c6422110bc0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 67da1a478db26ad45f36a673218d526f8962d72f"
iuc
parents: 24
diff changeset
8 <requirement type="package" version="5.0.1">gawk</requirement>
c6422110bc0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 67da1a478db26ad45f36a673218d526f8962d72f"
iuc
parents: 24
diff changeset
9 </expand>
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
10 </requirements>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
11 <expand macro="stdio" />
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
12 <expand macro="version_command" />
27
c6422110bc0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 67da1a478db26ad45f36a673218d526f8962d72f"
iuc
parents: 24
diff changeset
13 <command detect_errors="exit_code"><![CDATA[
24
4c790901c495 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit fafb197acfe233d18a542e8c567943faf9abc3aa
iuc
parents: 23
diff changeset
14 snpEff @JAVA_OPTIONS@ dump
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
15 #if $snpDb.genomeSrc == 'cached':
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
16 -dataDir ${snpDb.genomeVersion.fields.path}
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
17 $snpDb.genomeVersion
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
18 #elif $snpDb.genomeSrc == 'history':
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
19 -dataDir '${snpDb.snpeff_db.extra_files_path}'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
20 '${snpDb.snpeff_db.metadata.genome_version}'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
21 #elif $snpDb.genomeSrc == 'custom':
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
22 -dataDir '${snpDb.snpeff_db.extra_files_path}'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
23 -configOption '${snpDb.snpeff_db.metadata.genome_version}'.genome='${snpDb.snpeff_db.metadata.genome_version}'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
24 '${snpDb.snpeff_db.metadata.genome_version}'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
25 #else
24
4c790901c495 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit fafb197acfe233d18a542e8c567943faf9abc3aa
iuc
parents: 23
diff changeset
26 -dataDir "\$PWD/temp"
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
27 -download
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
28 '$snpDb.genome_version'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
29 #end if
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
30 | awk '/# Chromosomes/{y=1;next}y' | grep "#" | grep -E "[0-9]" | awk 'BEGIN {err=1;} {c=$0;sub(/^[^a-zA-Z0-9_]+/, "", c) && err=0; sub(/[^a-zA-Z0-9_]+/, "\t", c) && err=0; sub(/[^0-9]*$/, "", c) && err=0; print c } END {exit err}' > '$chr_names'
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
31 ]]></command>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
32 <inputs>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
33 <conditional name="snpDb">
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
34 <param name="genomeSrc" type="select" label="Genome source">
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
35 <!-- These options are referenced in the help section of SnpEff download tool. If you change them, change help of SnpEff download as well -->
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
36 <option value="cached">Locally installed snpEff database</option>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
37 <option value="history">Downloaded snpEff database in your history</option>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
38 <option value="named">Download on demand</option>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
39 <option value="custom">Custom snpEff database in your history</option>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
40 </param>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
41 <when value="cached">
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
42 <param name="genomeVersion" type="select" label="Genome">
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
43 <help>This can only be used on built-in databases manually configured by your galaxy admin.</help>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
44 <options from_data_table="snpeffv_genomedb">
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
45 <filter type="regexp" column="1" value="@COMPATIBLE_DB_VERSIONS_REGEX@" />
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
46 <filter type="unique_value" column="2" />
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
47 </options>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
48 </param>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
49 </when>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
50 <when value="history">
23
ad77eac03bf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 530737ce6054364b394db08d42e3777355fa5c05
iuc
parents: 22
diff changeset
51 <param name="snpeff_db" type="data" format="snpeffdb" label="@SNPEFF_VERSION@ Genome Data">
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
52 <help>This can only be used on databases in your history that were downloaded using the snpEff download tool.</help>
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
53 <validator type="expression" message="This version of SnpEff will only work with @COMPATIBLE_DB_VERSIONS_STRING@ genome databases">value.metadata.snpeff_version in @COMPATIBLE_DB_VERSIONS@</validator>
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
54 </param>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
55 </when>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
56 <when value="named">
24
4c790901c495 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit fafb197acfe233d18a542e8c567943faf9abc3aa
iuc
parents: 23
diff changeset
57 <param name="genome_version" type="text" value="" label="Snpff Genome Version Name (e.g. GRCh38.86)">
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
58 <help>The list of available databases can be obtained with 'SnpEff databases' tool. If the database name is not found, locate a database here and download it in your history.</help>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
59 <validator type="regex" message="A genome version name is required">\S+</validator>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
60 </param>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
61 </when>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
62 <when value="custom">
23
ad77eac03bf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 530737ce6054364b394db08d42e3777355fa5c05
iuc
parents: 22
diff changeset
63 <param name="snpeff_db" type="data" format="snpeffdb" label="@SNPEFF_VERSION@ Genome Data">
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
64 <help>This can only be used on databases in your history that were created using the snpEff build tool.</help>
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
65 <validator type="expression" message="This version of SnpEff will only work with @COMPATIBLE_DB_VERSIONS_STRING@ genome databases">value.metadata.snpeff_version in @COMPATIBLE_DB_VERSIONS@</validator>
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
66 </param>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
67 </when>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
68 </conditional>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
69 </inputs>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
70 <outputs>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
71 <data format="tabular" name="chr_names" label="Chromosome names and sizes"/>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
72 </outputs>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
73 <tests>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
74 <test>
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
75 <conditional name="snpDb">
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
76 <param name="genomeSrc" value="cached"/>
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
77 <param name="genomeVersion" value="ebola_zaire"/>
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
78 </conditional>
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
79 <output name="chr_names">
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
80 <assert_contents>
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
81 <has_text text="KJ660346" />
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
82 <has_text text="18959" />
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
83 </assert_contents>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
84 </output>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
85 </test>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
86 <test expect_failure="True">
33
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
87 <conditional name="snpDb">
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
88 <param name="genomeSrc" value="named"/>
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
89 <param name="genome_version" value="should_not_match"/>
94653948fdb9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
iuc
parents: 32
diff changeset
90 </conditional>
22
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
91 </test>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
92 </tests>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
93 <help><![CDATA[
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
94
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
95 **What it does**
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
96
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
97 This tool outputs a tab-delimited file of chromosome names and their lengths, as they are in the selected genome/SnpEff database. The output can be used to validate and rename chromosomes in VCF files in order to annotate its records.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
98
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
99 Note, make sure that the genome you select from the snpEff database precisely matches the one used in your analysis. As a cursory check, you can use the chromosome lengths in this output to match those in your reference, however the lengths can match, but the version may still differ.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
100
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
101 Known issue: this strategy will not work if more than 1 chromosome in the same genome has the same length.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
102
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
103 -------
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
104
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
105 .. class:: infomark
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
106
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
107 **The usage scenario**
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
108
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
109 Suppose you want to use snpEff to annotate a VCF file that was generated using an mouse reference with a different chromosome naming convention than in the snpEff database. To do this you can:
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
110
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
111 #. Use `SnpEff databases` to find the precise genome name for mouse data (e.g. "mm10") as it appears in the snpEff database.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
112 #. List the chromosome names using this tool. Either select a built-in genome, one in your history, or select "Download on demand" and enter the genome version obtained in the previous step (which only actually downloads if snpEff doesn't already have it).
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
113 #. Check that the chromosomes in the SnpEff database are the same as the reference you used (e.g. as a cursory check, ensure the chromosome lengths reported from the SnpEff database match those of your reference).
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
114 #. Edit your vcf file to replace the chromosome names with the ones the SnpEff database uses.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
115 #. Use **SnpEff eff** and supply the edited VCF file.
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
116
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
117 ]]></help>
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
118 <expand macro="citations" />
6c5860f1be74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 680a6111d751031f02233715a529a336ad4b2bf4
iuc
parents:
diff changeset
119 </tool>