annotate vcfcheck.xml @ 3:5e850c85ba32 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfcheck commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
author iuc
date Mon, 26 Mar 2018 12:22:22 -0400
parents 40a339e4692e
children 2968c6916579
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
5e850c85ba32 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfcheck commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
iuc
parents: 2
diff changeset
1 <tool id="vcfcheck" name="VCFcheck:" version="@WRAPPER_VERSION@+galaxy0">
2
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
2 <description>Verify that the reference allele matches the reference genome</description>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
3 <macros>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
4 <import>macros.xml</import>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
5 </macros>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
6 <expand macro="requirements"></expand>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
7 <stdio>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
8 <regex match="index file" source="stderr" level="warning"/>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
9 </stdio>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
10 <command>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
11 #set $reference_fasta_filename = "localref.fa"
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
12 #if str( $reference_source.reference_source_selector ) == "history":
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
13 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
14 #else:
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
15 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
16 #end if
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
17 vcfcheck $failure_selector -f "${reference_fasta_filename}" "${input_vcf}" > "${out_file1}"</command>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
18 <inputs>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
19 <conditional name="reference_source">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
20 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
21 <option value="cached">Locally cached</option>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
22 <option value="history">History</option>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
23 </param>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
24 <when value="cached">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
25 <param name="ref_file" type="select" label="Select reference genome">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
26 <options from_data_table="fasta_indexes">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
27 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
28 </options>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
29 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
30 </param>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
31 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
32 <!-- Validators are commented to allow users apply too to any build. May need to be revised in the future
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
33 <validator type="unspecified_build" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
34 <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." />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
35 -->
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
36 </param>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
37 </when>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
38 <when value="history"> <!-- FIX ME!!!! -->
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
39 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
40 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
41 </when>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
42 </conditional>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
43 <param name="failure_selector" type="select" display="radio" label="Exclude or include failed sites">
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
44 <option value="-x">Exculde failures (-x option)</option>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
45 <option value="-k">Keep failures (-k option)</option>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
46 </param>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
47 </inputs>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
48 <outputs>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
49 <data format="vcf" name="out_file1" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
50 </outputs>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
51 <tests>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
52 <test>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
53 <param name="reference_source_selector" value="history" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
54 <param name="failure_selection" value="-x" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
55 <param name="input_vcf" value="vcflib-phix.vcf"/>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
56 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
57 <output name="out_file1" file="vcfcheck-test1.vcf"/>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
58 </test>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
59 </tests>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
60 <help>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
61
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
62 Verifies that the VCF REF field matches the reference as described.
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
63
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
64 The options are::
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
65
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
66 -x, --exclude-failures If a record fails, don't print it. Otherwise do.
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
67 -k, --keep-failures Print if the record fails, otherwise not.
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
68
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
69 ----
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
70
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
71 Vcfcheck @IS_PART_OF_VCFLIB@
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
72 </help>
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
73 <expand macro="citations" />
40a339e4692e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfcheck commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
74 </tool>