annotate bcftools_query.xml @ 16:3ce32adc55b2 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
author iuc
date Tue, 20 Sep 2022 13:12:13 +0000
parents 94c5f302f0ea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
16
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
2 <tool name="bcftools @EXECUTABLE@" id="bcftools_@EXECUTABLE@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
3 <description>Extracts fields from VCF/BCF file and prints them in user-defined format</description>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
4 <macros>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
5 <token name="@EXECUTABLE@">query</token>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
6 <import>macros.xml</import>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
7 </macros>
14
94c5f302f0ea "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit af43d9cf6824f88726900857116f333ff4cdd336"
iuc
parents: 13
diff changeset
8 <expand macro="bio_tools" />
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
9 <expand macro="requirements" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
10 <expand macro="version_command" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
11 <command detect_errors="aggressive"><![CDATA[
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
12 @PREPARE_ENV@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
13 @PREPARE_INPUT_FILES@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
14 #set $section = $sec_restrict
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
15 @PREPARE_TARGETS_FILE@
5
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
16 @PREPARE_REGIONS_FILE@
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
17
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
18 bcftools @EXECUTABLE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
19
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
20 ## Query section
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
21 #set $section = $sec_query
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
22 --format '${section.format}'
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
23
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
24 ${section.allow_undef_tags}
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
25
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
26 ${section.print_header}
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
27
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
28 ## Default section
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
29 #set $section = $sec_restrict
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
30 @INCLUDE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
31 @EXCLUDE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
32 @COLLAPSE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
33 @REGIONS@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
34 @SAMPLES@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
35 @TARGETS@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
36
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
37 ## Primary Input/Outputs
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
38 --vcf-list @INPUT_LIST_FILE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
39 > $output_file
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
40 ]]>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
41 </command>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
42 <inputs>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
43 <expand macro="macro_inputs" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
44 <section name="sec_restrict" expanded="false" title="Restrict to">
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
45 <expand macro="macro_collapse" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
46 <expand macro="macro_samples" />
8
0770b1203e90 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 7
diff changeset
47 <expand macro="macro_restrict" />
0770b1203e90 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit e648d86d550ddf2eb67237752320c390b3a780e5
iuc
parents: 7
diff changeset
48 <expand macro="macro_restrict" type="target" label_type="Target" />
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
49 <expand macro="macro_include" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
50 <expand macro="macro_exclude" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
51 </section>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
52 <section name="sec_query" expanded="true" title="Query Options">
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
53 <param name="format" type="text" value="" label="Format for Output">
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
54 <help>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
55 <![CDATA[
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
56 Example: %CHROM\t%POS\t%REF\t%ALT{0}\n
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
57 ( NOTE TAB: '\t' and new line character: '\n' )
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
58 ]]>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
59 </help>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
60 <sanitizer sanitize="False"/>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
61 <validator type="empty_field" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
62 </param>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
63 <param name="tsv" type="boolean" truevalue="True" falsevalue="False" checked="false" label="Output is tab-delimited"
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
64 help="Fields in your Format are separated by a TAB character: \t"/>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
65 <param name="allow_undef_tags" type="boolean" truevalue="--allow-undef-tags" falsevalue="" label="Allow Undefined Tags"
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
66 help="Print &quot;.&quot; for undefined tags" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
67 <param name="print_header" type="boolean" truevalue="--print-header" falsevalue="" label="Print Header Line" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
68 </section>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
69
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
70 </inputs>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
71 <outputs>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
72 <data name="output_file" format="txt">
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
73 <change_format>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
74 <when input="tsv" value="True" format="tabular" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
75 </change_format>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
76 </data>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
77 </outputs>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
78 <tests>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
79 <test>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
80 <param name="input_files" ftype="vcf" value="query.vcf" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
81 <param name="format" value="%CHROM\t%POS\t%REF\t%ALT\t%DP4\t%AN[\t%GT\t%TGT]\n" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
82 <param name="tsv" value="True" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
83 <output name="output_file" file="query.out" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
84 </test>
16
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
85 <!-- Test region overlap option-->
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
86 <test>
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
87 <param name="input_files" ftype="vcf" value="query.vcf" />
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
88 <param name="format" value="%CHROM\t%POS\t%REF\t%ALT\t%DP4\t%AN[\t%GT\t%TGT]\n" />
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
89 <param name="tsv" value="True" />
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
90 <section name="sec_restrict">
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
91 <param name="regions_overlap" value="1"/>
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
92 </section>
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
93 <output name="output_file" file="query.out" />
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
94 <assert_command>
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
95 <has_text text="--regions-overlap" />
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
96 </assert_command>
3ce32adc55b2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit db275932cbb485cb44ae91e0b421d6f57698db49
iuc
parents: 14
diff changeset
97 </test>
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
98 </tests>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
99 <help><![CDATA[
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
100 =====================================
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
101 bcftools @EXECUTABLE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
102 =====================================
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
103
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
104 Extracts fields from VCF/BCF file and prints them in user-defined format
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
105
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
106 Format:
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
107
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
108 ::
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
109
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
110 ``%CHROM`` The CHROM column (similarly also other columns: POS, ID, REF, ALT, QUAL, FILTER)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
111 ``%INFO/TAG`` Any tag in the INFO column
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
112 ``%TYPE`` Variant type (REF, SNP, MNP, INDEL, OTHER)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
113 ``%MASK`` Indicates presence of the site in other files (with multiple files)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
114 ``%TAG{INT}`` Curly brackets to subscript vectors (0-based)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
115 ``%FIRST_ALT`` Alias for %ALT{0}
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
116 ``[]`` The brackets loop over all samples
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
117 ``%GT`` Genotype (e.g. 0/1)
5
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
118 ``%TBCSQ`` Translated FORMAT/BCSQ. See the csq command above for explanation and examples.
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
119 ``%TGT`` Translated genotype (e.g. C/A)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
120 ``%IUPACGT`` Genotype translated to IUPAC ambiguity codes (e.g. M instead of C/A)
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
121 ``%LINE`` Prints the whole line
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
122 ``%SAMPLE`` Sample name
5
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
123 ``%POS0`` POS in 0-based coordinates
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
124 ``%END`` End position of the REF allele
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
125 ``%END0`` End position of the REF allele in 0-based cordinates
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
126 ``\n`` new line
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
127 ``\t`` tab character
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
128
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
129
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
130 Examples:
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
131
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
132 ::
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
133
5
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
134 # Print chromosome, position, ref allele and the first alternate allele
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
135 bcftools query -f '%CHROM %POS %REF %ALT{0}\n' file.vcf.gz
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
136
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
137 # Similar to above, but use tabs instead of spaces, add sample name and genotype
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
138 bcftools query -f '%CHROM\t%POS\t%REF\t%ALT[\t%SAMPLE=%GT]\n' file.vcf.gz
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
139
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
140 # Print FORMAT/GT fields followed by FORMAT/GT fields
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
141 bcftools query -f 'GQ:[ %GQ] \t GT:[ %GT]\n' file.vcf
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
142
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
143 # Make a BED file: chr, pos (0-based), end pos (1-based), id
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
144 bcftools query -f'%CHROM\t%POS0\t%END\t%ID\n' file.bcf
24ff7b989329 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents: 4
diff changeset
145
0
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
146
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
147 @COLLAPSE_HELP@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
148 @REGIONS_HELP@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
149 @TARGETS_HELP@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
150 @EXPRESSIONS_HELP@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
151
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
152 @BCFTOOLS_MANPAGE@#@EXECUTABLE@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
153
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
154 @BCFTOOLS_WIKI@
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
155 ]]>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
156 </help>
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
157 <expand macro="citations" />
2fea169065ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
158 </tool>