annotate vcfprimers.xml @ 0:cee219e163fa

Imported from capsule None
author anton
date Wed, 11 Jun 2014 17:10:20 -0400
parents
children 8be427d0e4c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
1 <tool id="vcfprimers" name="VCFprimers:" version="0.0.1">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
4 <!-- <requirement type="package" version="0.1.18">samtools</requirement> -->
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
5 </requirements>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
6 <description>Extract flanking sequences for each VCF record</description>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
7 <command>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
8 #set $reference_fasta_filename = "localref.fa"
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
9 #if str( $reference_source.reference_source_selector ) == "history":
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
10 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
11 #else:
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
12 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
13 #end if
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
14 vcfprimers -f "${reference_fasta_filename}" -l "${primer_length}" "${input_vcf}" > "${out_file1}"</command>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
15 <inputs>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
16 <param name="input_vcf" type="data" format="vcf" label="VCF dataset to extract flanks" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
17 <conditional name="reference_source">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
18 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
19 <option value="cached">Locally cached</option>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
20 <option value="history">History</option>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
21 </param>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
22 <when value="cached">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
23 <param name="ref_file" type="select" label="Select reference genome">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
24 <options from_data_table="fasta_indexes">
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
25 </options>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
26 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
27 </param>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
28 </when>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
29 <when value="history"> <!-- FIX ME!!!! -->
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
30 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
31 </when>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
32 </conditional>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
33 <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" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
34 </inputs>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
35 <outputs>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
36 <data format="fasta" name="out_file1" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
37 </outputs>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
38 <stdio>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
39 <exit_code range="1:" level="fatal" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
40 </stdio>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
41 <tests>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
42 <test>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
43 <param name="reference_source_selector" value="history" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
44 <param name="input_vcf" value="vcflib-phix.vcf"/>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
45 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
46 <param name="primer_length" value="5" />
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
47 <output name="out_file1" file="vcfprimers-test1.fasta"/>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
48 </test>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
49 </tests>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
50 <help>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
51
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
52 For each VCF record, extract the flanking sequences, and write them to stdout as FASTA
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
53 records suitable for alignment. This tool is intended for use in designing validation
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
54 experiments. Primers extracted which would flank all of the alleles at multi-allelic
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
55 sites. The name of the FASTA "reads" indicates the VCF record which they apply to.
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
56 The form is >CHROM_POS_LEFT for the 3' primer and >CHROM_POS_RIGHT for the 5' primer,
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
57 for example::
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
58
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
59 >20_233255_LEFT
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
60 CCATTGTATATATAGACCATAATTTCTTTATCCAATCATCTGTTGATGGA
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
61 >20_233255_RIGHT
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
62 ACTCAGTTGATTCCATACCTTTGCCATCATGAATCATGTTGTAATAAACA
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
63
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
64 ----
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
65
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
66 Vcfprimers is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
67
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
68 </help>
cee219e163fa Imported from capsule None
anton
parents:
diff changeset
69 </tool>