annotate vcfprimers.xml @ 2:c3a5388628b5 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
author devteam
date Thu, 15 Sep 2016 16:04:39 -0400
parents 15ec0bdaf4dd
children 086d3cd0aaf9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
1 <tool id="vcfprimers" name="VCFprimers:" version="@WRAPPER_VERSION@.0">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
2 <description>Extract flanking sequences for each VCF record</description>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
3 <macros>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
4 <import>macros.xml</import>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
5 </macros>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
6 <expand macro="requirements"/>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
7 <expand macro="stdio" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
8 <command>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
9 #set $reference_fasta_filename = "localref.fa"
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
10 #if str( $reference_source.reference_source_selector ) == "history":
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
11 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
12 #else:
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
13 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
14 #end if
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
15 vcfprimers -f "${reference_fasta_filename}" -l "${primer_length}" "${input_vcf}" > "${out_file1}"</command>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
16 <inputs>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
17 <param name="input_vcf" type="data" format="vcf" label="VCF dataset to extract flanks" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
18 <conditional name="reference_source">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
19 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
20 <option value="cached">Locally cached</option>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
21 <option value="history">History</option>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
22 </param>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
23 <when value="cached">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
24 <param name="ref_file" type="select" label="Select reference genome">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
25 <options from_data_table="fasta_indexes">
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
26 </options>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers 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"/>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
28 </param>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
29 </when>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
30 <when value="history"> <!-- FIX ME!!!! -->
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
31 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
32 </when>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
33 </conditional>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
34 <param name="primer_length" type="integer" value="20" label="The length of the primer sequences on each side of the variant" help="default = 20 bp" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
35 </inputs>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
36 <outputs>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
37 <data format="fasta" name="out_file1" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
38 </outputs>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
39 <tests>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
40 <test>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
41 <param name="reference_source_selector" value="history" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
42 <param name="input_vcf" value="vcflib-phix.vcf"/>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
43 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
44 <param name="primer_length" value="5" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
45 <output name="out_file1" file="vcfprimers-test1.fasta"/>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
46 </test>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
47 </tests>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
48 <help>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
49
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
50 For each VCF record, extract the flanking sequences, and write them as FASTA
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
51 records suitable for alignment. This tool is intended for use in designing validation
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
52 experiments. Primers extracted which would flank all of the alleles at multi-allelic
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
53 sites. The name of the FASTA "reads" indicates the VCF record which they apply to.
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
54 The form is >CHROM_POS_LEFT for the 3' primer and >CHROM_POS_RIGHT for the 5' primer,
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
55 for example::
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
56
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
57 >20_233255_LEFT
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
58 CCATTGTATATATAGACCATAATTTCTTTATCCAATCATCTGTTGATGGA
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
59 >20_233255_RIGHT
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
60 ACTCAGTTGATTCCATACCTTTGCCATCATGAATCATGTTGTAATAAACA
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
61
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
62 ----
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
63
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
64 Vcfprimers @IS_PART_OF_VCFLIB@
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
65 </help>
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
66 <expand macro="citations" />
c3a5388628b5 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfprimers commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
67 </tool>