annotate bcftools_csq.xml @ 3:40388f544e5d draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
author iuc
date Wed, 05 Jun 2019 13:09:13 -0400
parents 039ea3f1dea9
children f10f5b4e7854
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
2 <tool name="bcftools @EXECUTABLE@" id="bcftools_@EXECUTABLE@" version="@TOOL_VERSION@+galaxy1">
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
3 <description>Haplotype aware consequence predictor</description>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
4 <macros>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
5 <token name="@EXECUTABLE@">csq</token>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
6 <import>macros.xml</import>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
7 </macros>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
8 <expand macro="requirements">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
9 <expand macro="samtools_requirement"/>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
10 </expand>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
11 <expand macro="version_command" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
12 <command detect_errors="aggressive"><![CDATA[
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
13 @PREPARE_ENV@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
14 @PREPARE_INPUT_FILE@
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
15 #set $section = $sec_required.reference_source
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
16 @PREPARE_FASTA_REF@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
17
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
18 #set $section = $sec_restrict
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
19 @PREPARE_TARGETS_FILE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
20 @PREPARE_REGIONS_FILE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
21
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
22 bcftools @EXECUTABLE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
23
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
24 ## csq required inputs section
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
25 #set $section = $sec_required.reference_source
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
26 @FASTA_REF@
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
27 --gff-annot '$sec_required.gff_annot'
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
28
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
29 ## csq options section
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
30 #if str($sec_csq_opts.ncsq):
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
31 --ncsq $sec_csq_opts.ncsq
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
32 #end if
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
33 $sec_csq_opts.local_csq
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
34 #if $sec_csq_opts.phase:
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
35 --phase $sec_csq_opts.phase
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
36 #end if
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
37 #if str($sec_csq_opts.custom_tag):
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
38 --custom-tag '$sec_csq_opts.custom_tag'
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
39 #end if
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
40
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
41 ## Subset section
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
42 #set $section = $sec_subset
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
43 @SAMPLES@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
44
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
45 ## Filter section
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
46 #set $section = $sec_restrict
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
47 @INCLUDE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
48 @EXCLUDE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
49 @REGIONS@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
50 @TARGETS@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
51
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
52 @OUTPUT_TYPE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
53
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
54 ## Primary Input/Outputs
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
55 @INPUT_FILE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
56 > '$output_file'
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
57
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
58 ]]>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
59 </command>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
60 <inputs>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
61 <expand macro="macro_input" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
62 <section name="sec_required" expanded="true" title="Required References">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
63 <expand macro="macro_fasta_ref" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
64 <param name="gff_annot" type="data" format="gff3" label="GFF3 annotation file"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
65 help="From Ensembl: ftp://ftp.ensembl.org/pub/current_gff3/"/>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
66 </section>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
67 <section name="sec_csq_opts" expanded="true" title="CSQ Options">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
68 <param name="ncsq" type="integer" value="16" min="1" max="50" label="maximum number of consequences to consider per site"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
69 help="-ncsq 16"/>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
70 <param name="local_csq" type="boolean" truevalue="--local-csq" falsevalue="" checked="false" label="run localized predictions considering only one VCF record at a time"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
71 help="--local-csq switch off haplotype-aware calling, run localized predictions considering only one VCF record at a time"/>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
72 <param name="phase" type="select" optional="true" label="phase"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
73 help="how to construct haplotypes and how to deal with unphased data">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
74 <option value="a">take GTs as is, create haplotypes regardless of phase (0/1 -> 0|1)</option>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
75 <option value="m">merge *all* GTs into a single haplotype (0/1 -> 1, 1/2 -> 1)</option>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
76 <option value="r">require phased GTs, throw an error on unphased het GTs</option>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
77 <option value="R">create non-reference haplotypes if possible (0/1 -> 1|1, 1/2 -> 1|2)</option>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
78 <option value="s">skip unphased GTs</option>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
79 </param>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
80 <param name="custom_tag" type="text" value="" optional="true"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
81 label="use this custom tag to store consequences rather than the default BCSQ tag">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
82 <validator type="regex" message="">^(\w+)?$</validator>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
83 </param>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
84 </section>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
85
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
86 <section name="sec_restrict" expanded="false" title="Restrict to">
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
87 <expand macro="macro_restrict" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
88 <expand macro="macro_restrict" type="target" label_type="Target" />
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
89 <expand macro="macro_include" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
90 <expand macro="macro_exclude" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
91 </section>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
92 <section name="sec_subset" expanded="false" title="Subset Options">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
93 <expand macro="macro_samples" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
94 </section>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
95 <expand macro="macro_select_output_type" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
96 </inputs>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
97 <outputs>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
98 <expand macro="macro_vcf_output" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
99 </outputs>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
100 <tests>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
101 <test>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
102 <param name="input_file" ftype="vcf" value="csq.vcf" />
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
103 <expand macro="test_using_reference" ref="csq.fa" />
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
104 <param name="gff_annot" ftype="gff3" value="csq.gff3" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
105 <param name="output_type" value="v" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
106 <output name="output_file">
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
107 <assert_contents>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
108 <has_text text="BCSQ" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
109 </assert_contents>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
110 </output>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
111 </test>
3
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
112 <test>
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
113 <param name="input_file" ftype="vcf" dbkey="?" value="csq.vcf" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
114 <expand macro="test_using_reference" select_from="cached" ref="csq" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
115 <param name="gff_annot" ftype="gff3" value="csq.gff3" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
116 <param name="output_type" value="v" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
117 <output name="output_file">
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
118 <assert_contents>
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
119 <has_text text="BCSQ" />
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
120 </assert_contents>
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
121 </output>
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
122 </test>
40388f544e5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 2
diff changeset
123
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
124 </tests>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
125 <help><![CDATA[
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
126 =====================================
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
127 bcftools @EXECUTABLE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
128 =====================================
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
129
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
130 Haplotype aware consequence predictor which correctly handles combined variants such as MNPs split over
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
131 multiple VCF records, SNPs separated by an intron (but adjacent in the spliced transcript) or nearby
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
132 frame-shifting indels which in combination in fact are not frame-shifting.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
133
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
134 The output VCF is annotated with INFO/BCSQ and FORMAT/BCSQ tag (configurable with the -c option).
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
135 The latter is a bitmask of indexes to INFO/BCSQ, with interleaved haplotypes. See the usage examples
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
136 below for using the %TBCSQ converter in query for extracting a more human readable form from this bitmask.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
137 The contruction of the bitmask limits the number of consequences that can be referenced in the FORMAT/BCSQ tags.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
138 By default this is 16, but if more are required, see the --ncsq option.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
139
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
140 The program requires on input a VCF/BCF file, the reference genome in fasta format (--fasta-ref)
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
141 and genomic features in the GFF3 format downloadable from the Ensembl website (--gff-annot),
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
142 and outputs an annotated VCF/BCF file. Currently, only Ensembl GFF3 files are supported.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
143
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
144 By default, the input VCF should be phased. If phase is unknown, or only partially known,
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
145 the --phase option can be used to indicate how to handle unphased data. Alternatively,
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
146 haplotype aware calling can be turned off with the --local-csq option.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
147
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
148 If conflicting (overlapping) variants within one haplotype are detected, a warning will
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
149 be emitted and predictions will be based on only the first variant in the analysis.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
150
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
151 Symbolic alleles are not supported. They will remain unannotated in the output VCF and are
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
152 ignored for the prediction analysis.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
153
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
154
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
155 @REGIONS_HELP@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
156 @TARGETS_HELP@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
157
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
158 @BCFTOOLS_MANPAGE@#@EXECUTABLE@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
159
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
160 @BCFTOOLS_WIKI@
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
161 ]]>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
162 </help>
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
163 <expand macro="citations" />
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
164 </tool>