annotate alignCustomAmplicon/alignCustomAmplicon_wrapper.xml @ 2:413ba6d9cc46 draft

Uploaded
author fcaramia
date Wed, 09 Jan 2013 00:35:38 -0500
parents 6a1b222df393
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
1 <tool id="alignCustomAmplicon" name="Align Custom Amplicon" version="0.0.1">
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
2 <description>align amplicon to reference with primers</description>
1
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
3 <requirements>
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
4 <requirement type="package" version="1.56.0">picard</requirement>
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
5 <requirement type="package" version="0.1.18">samtools</requirement>
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
6 <requirement type="package" version="1.3.12">gzip</requirement>
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
7 <requirement type="perl-module" version="0.42">Inline-CPP</requirement>
6a1b222df393 Uploaded
fcaramia
parents: 0
diff changeset
8 </requirements>
0
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
9 <command interpreter="perl">
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
10 alignCustomAmplicon.pl -s -r -p 4 -o $output $refFile.fields.path $read1 $read2 $primers
2
413ba6d9cc46 Uploaded
fcaramia
parents: 1
diff changeset
11 -j "\$JAVA_JAR_PATH/MergeSamFiles.jar"
0
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
12 </command>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
13
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
14 <inputs>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
15 <param name="refFile" type="select" label="Select a reference genome">
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
16 <options from_data_table="all_fasta">
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
17 <filter type="sort_by" column="2" />
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
18 <validator type="no_options" message="No indexes are available" />
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
19 </options>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
20 </param>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
21 <param name="read1" type="data" format="fastqsanger,fastqillumina, fastq" label="FASTQ read 1 " help="FASTQ with either Sanger-scaled quality values (fastqsanger) or Illumina-scaled quality values (fastqillumina)" />
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
22 <param name="read2" type="data" format="fastqsanger,fastqillumina, fastq" label="FASTQ read 2" help="FASTQ with either Sanger-scaled quality values (fastqsanger) or Illumina-scaled quality values (fastqillumina)" />
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
23 <param name="primers" type="data" format="tabular" label="Primers" help="Primers location and length"/>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
24 </inputs>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
25
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
26 <outputs>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
27 <data type="data" format="bam" name="output"/>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
28 </outputs>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
29
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
30 <help>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
31
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
32 .. class:: infomark
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
33
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
34 **What it does**
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
35
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
36 It is an amplicon aligner that uses primers for higher accuracy.
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
37
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
38 Reads with primers are aligned to the reference, then primers are discarded.
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
39
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
40 If both reads are long enough, they are aligned with the reference and a consensus alignment is generated.
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
41
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
42 Otherwise, each read is aligned separately.
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
43
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
44 Sequences with bad quality reads are discarded.
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
45
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
46
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
47
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
48 **Input**
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
49
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
50 ref:
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
51
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
52 Fasta file of ref gnome
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
53
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
54 read1:
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
55
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
56 Fastq file of left to right read
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
57 (Can also be compressed [fastq.gz])
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
58
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
59 read2:
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
60
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
61 Fastq file of right to left read
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
62 (Can also be compressed [fastq.gz])
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
63
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
64 primers:
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
65
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
66 Text file with primers name and length (see example)
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
67
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
68 Example primers format::
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
69
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
70 #Name_of_amplicon length_left length_right
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
71 1:115256345-115256520 23 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
72 1:115256436-115256606 25 22
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
73 1:115256530-115256724 23 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
74 1:115256532-115256723 23 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
75 4:55151914-55152086 21 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
76 4:55151935-55152132 20 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
77 4:55151991-55152182 23 24
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
78 4:55591944-55592136 23 24
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
79 4:55592065-55592263 20 23
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
80 4:55593504-55593674 24 25
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
81 ...
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
82
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
83
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
84 </help>
d32bddcff685 Uploaded
fcaramia
parents:
diff changeset
85 </tool>