annotate vcfgeno2haplo.xml @ 3:25d297ce9ccb draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfgeno2haplo commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
author iuc
date Mon, 26 Mar 2018 12:14:25 -0400
parents d731d6f785b5
children 00f74c1efa2d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
25d297ce9ccb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfgeno2haplo commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
iuc
parents: 2
diff changeset
1 <tool id="vcfgeno2haplo" name="VCFgenotype-to-haplotype:" version="@WRAPPER_VERSION@+galaxy0">
2
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
2 <description>Convert genotype-based phased alleles into haplotype alleles</description>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
3 <macros>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
4 <import>macros.xml</import>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
5 </macros>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
6 <expand macro="requirements"/>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
7 <expand macro="stdio" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
8 <command>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
9 #set $reference_fasta_filename = "localref.fa"
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
10 #if str( $reference_source.reference_source_selector ) == "history":
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
11 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
12 #else:
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
13 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
14 #end if
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
15 vcfgeno2haplo ${output_option} -w ${window_size} -r "${reference_fasta_filename}" "${input_vcf}" > "${out_file1}"</command>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
16 <inputs>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
17 <conditional name="reference_source">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
18 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
19 <option value="cached">Locally cached</option>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
20 <option value="history">History</option>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
21 </param>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
22 <when value="cached">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
23 <param name="ref_file" type="select" label="Select reference genome">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
24 <options from_data_table="fasta_indexes">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
25 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
26 </options>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
27 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
28 </param>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
29 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset">
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
30 <!-- Validators are commented to allow users apply too to any build. May need to be revised in the future
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
31 <validator type="unspecified_build" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
32 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
33 -->
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
34 </param>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
35 </when>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
36 <when value="history"> <!-- FIX ME!!!! -->
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
37 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
38 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
39 </when>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
40 </conditional>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
41 <param name="window_size" type="text" value="30" label="compare records up to this many bp away" help="--window-size option (default = 30)" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
42 <param name="output_option" type="boolean" truevalue="-o" falsevalue="" label="What to report?" help="--only-variants option" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
43 <!-- <option value=" ">Output entire haplotype</option>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
44 <option value="-o">Don't output the entire haplotype, just concatenate REF/ALT strings (delimited by &quot;:&quot;)</option>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
45 </param> -->
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
46 </inputs>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
47 <outputs>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
48 <data format="vcf" name="out_file1" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
49 </outputs>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
50 <tests>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
51 <test>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
52 <param name="reference_source_selector" value="history" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
53 <param name="output_option" value="true" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
54 <param name="window_size" value="5000" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
55 <param name="input_vcf" value="vcflib-phix.vcf"/>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
56 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
57 <output name="out_file1" file="vcfgeno2haplo-test1.vcf"/>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
58 </test>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
59 </tests>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
60 <help>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
61
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
62 Convert genotype-based phased alleles within a window size specified by -w option into haplotype alleles. Will break haplotype construction when encountering non-phased genotypes on input.
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
63
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
64 The options are::
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
65
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
66 -w, --window-size N Merge variants at most this many bp apart (default 30)
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
67 -o, --only-variants Don't output the entire haplotype, just concatenate
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
68 REF/ALT strings (delimited by ":")
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
69
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
70 ----
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
71
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
72 Vcfgeno2haplo @IS_PART_OF_VCFLIB@
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
73 </help>
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
74 <expand macro="citations" />
d731d6f785b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfgeno2haplo commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
75 </tool>