annotate bcftools_consensus.xml @ 1:91bb0b5cfef4 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit a9550d87541eda8b909e6aef1ad8cbf9e9e20d06
author iuc
date Wed, 13 Jul 2016 10:56:32 -0400
parents 74b27d899b85
children 5410e1408bce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
74b27d899b85 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'?>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
2 <tool name="bcftools @EXECUTABLE@" id="bcftools_@EXECUTABLE@" version="@VERSION@.0">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
3 <description>Create consensus sequence by applying VCF variants to a reference fasta file</description>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
4 <macros>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
5 <token name="@EXECUTABLE@">consensus</token>
74b27d899b85 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>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
7 </macros>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
8 <expand macro="requirements" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
9 <expand macro="version_command" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
10 <command detect_errors="aggressive"><![CDATA[
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
11 @PREPARE_ENV@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
12 @PREPARE_INPUT_FILE@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
13 #set $section = $sec_default
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
14 @PREPARE_FASTA_REF@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
15
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
16 bcftools @EXECUTABLE@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
17
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
18 ## Default section
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
19 #set $section = $sec_default
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
20 @FASTA_REF@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
21
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
22 ${section.iupac_codes}
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
23
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
24 #if $section.mask:
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
25 --mask "${section.mask}"
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
26 #end if
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
27
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
28 #if $section.select_haplotype:
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
29 --haplotype "${section.select_haplotype}"
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
30 #end if
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
31 @SAMPLE@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
32
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
33 #if $chain:
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
34 --chain "$chain_file"
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
35 #end if
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
36
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
37 ## Primary Input/Outputs
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
38 --output "$output_file"
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
39 @INPUT_FILE@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
40 ]]>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
41 </command>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
42 <inputs>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
43 <expand macro="macro_input" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
44 <section name="sec_default" expanded="true" title="Default Options">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
45 <expand macro="macro_fasta_ref" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
46 <param name="mask" type="data" format="tabular" label="Mask" optional="True" help="Replace regions with N" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
47
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
48 <param name="iupac_codes" type="boolean" truevalue="--iupac-codes" falsevalue="" label="Iupac Codes"
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
49 help="Output variants in the form of IUPAC ambiguity codes" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
50 <expand macro="macro_sample" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
51 <param name="select_haplotype" type="select" optional="true">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
52 <option value="1">1</option>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
53 <option value="2">2</option>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
54 </param>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
55 </section>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
56 <param name="chain" type="boolean" truevalue="yes" falsevalue="no" label="Write a chain file for liftover" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
57 </inputs>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
58 <outputs>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
59 <data name="output_file" format="fasta" label="${tool.name} on ${on_string}: consensus fasta"/>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
60 <data name="chain_file" format="txt" label="${tool.name} on ${on_string}: chain">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
61 <filter>chain</filter>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
62 </data>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
63 </outputs>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
64 <tests>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
65 <test>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
66 <param name="fasta_ref" ftype="fasta" value="consensus.fa" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
67 <param name="input_file" ftype="vcf" value="consensus.vcf" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
68 <param name="mask" ftype="tabular" value="consensus.tab" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
69 <param name="chain" value="True" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
70 <output name="output_file">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
71 <assert_contents>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
72 <has_text text="NNNNNNNNNNNNNNNNNNNNNNNNNN" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
73 </assert_contents>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
74 </output>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
75 <output name="chain_file">
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
76 <assert_contents>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
77 <has_text text="chain 497 1 501 + 1 501 1 502 + 1 502 1" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
78 </assert_contents>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
79 </output>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
80 </test>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
81 </tests>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
82 <help><![CDATA[
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
83 =====================================
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
84 bcftools @EXECUTABLE@ plugin
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
85 =====================================
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
86
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
87
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
88 Create consensus sequence by applying VCF variants to a reference fasta file.
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
89
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
90 @BCFTOOLS_MANPAGE@#@EXECUTABLE@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
91
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
92 @BCFTOOLS_WIKI@
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
93 ]]>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
94 </help>
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
95 <expand macro="citations" />
74b27d899b85 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff changeset
96 </tool>