annotate stampy_wrapper.xml @ 5:bab6bc1c59ff draft

Uploaded
author subazini
date Wed, 17 Dec 2014 10:25:45 -0500
parents abe73a62b59a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
abe73a62b59a Uploaded
subazini
parents:
diff changeset
1 <tool id="Stampy" name="Stampy" version="1.0.21">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
2 <description>is a package for mapping of short reads from illumina sequencing machines onto a reference genome</description>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
3 <command interpreter="python"> stampy_wrapper.py
abe73a62b59a Uploaded
subazini
parents:
diff changeset
4
abe73a62b59a Uploaded
subazini
parents:
diff changeset
5 ## Indexing of the reference genome
abe73a62b59a Uploaded
subazini
parents:
diff changeset
6 --assembly=$Assembly
abe73a62b59a Uploaded
subazini
parents:
diff changeset
7 --species=$species
abe73a62b59a Uploaded
subazini
parents:
diff changeset
8 --genome_index=$G
abe73a62b59a Uploaded
subazini
parents:
diff changeset
9 --output=$output
abe73a62b59a Uploaded
subazini
parents:
diff changeset
10
abe73a62b59a Uploaded
subazini
parents:
diff changeset
11 ## Reference genome for creating index
abe73a62b59a Uploaded
subazini
parents:
diff changeset
12 --genome=$input
abe73a62b59a Uploaded
subazini
parents:
diff changeset
13 #if $refGenomeSource.genomeSource == "indexed":
abe73a62b59a Uploaded
subazini
parents:
diff changeset
14 --genome1="${refGenomeSource.index.fields.path}"
abe73a62b59a Uploaded
subazini
parents:
diff changeset
15 #end if
abe73a62b59a Uploaded
subazini
parents:
diff changeset
16 ## input file for single paired read
abe73a62b59a Uploaded
subazini
parents:
diff changeset
17 --input1=$input1
abe73a62b59a Uploaded
subazini
parents:
diff changeset
18
abe73a62b59a Uploaded
subazini
parents:
diff changeset
19 ## Second input only if input is paired-end.
abe73a62b59a Uploaded
subazini
parents:
diff changeset
20 #if $singlePaired.sPaired == "paired"
abe73a62b59a Uploaded
subazini
parents:
diff changeset
21 --input1=$singlePaired.input1
abe73a62b59a Uploaded
subazini
parents:
diff changeset
22 --input2=$singlePaired.input2
abe73a62b59a Uploaded
subazini
parents:
diff changeset
23 #end if
abe73a62b59a Uploaded
subazini
parents:
diff changeset
24 ## Parameters
abe73a62b59a Uploaded
subazini
parents:
diff changeset
25 --settings=$params.settingsType
abe73a62b59a Uploaded
subazini
parents:
diff changeset
26 #if $params.settingsType == "full":
abe73a62b59a Uploaded
subazini
parents:
diff changeset
27 --sd=${params.d}
abe73a62b59a Uploaded
subazini
parents:
diff changeset
28 --insert=${params.i}
abe73a62b59a Uploaded
subazini
parents:
diff changeset
29 --subrate=${params.r}
abe73a62b59a Uploaded
subazini
parents:
diff changeset
30 #end if
abe73a62b59a Uploaded
subazini
parents:
diff changeset
31 </command>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
32 <inputs>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
33 <param name="Assembly" type="text" value=""/>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
34 <param name="species" type="text" value=""/>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
35 <param name="G" type="text" value=""/>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
36
abe73a62b59a Uploaded
subazini
parents:
diff changeset
37 <conditional name="refGenomeSource">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
38 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
39 <option value="indexed">Use a built-in index</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
40 <option value="history" selected="true">Use one from the history</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
41 </param>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
42 <when value="indexed">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
43 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
44 <options from_file="stampy_indices.loc">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
45 <column name ="value" index="0" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
46 <column name ="name" index="1" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
47 </options>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
48 </param>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
49 </when>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
50 <when value="history">hg18_
abe73a62b59a Uploaded
subazini
parents:
diff changeset
51 <param name="input" type="data" format="fna" metadata_name="dbkey" label="Select the reference genome" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
52 </when>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
53
abe73a62b59a Uploaded
subazini
parents:
diff changeset
54 </conditional>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
55 <conditional name="singlePaired">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
56 <param name="sPaired" type="select" label="Is this library mate-paired?">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
57 <option value="single">Single-end</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
58 <option value="paired">Paired-end</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
59 </param>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
60 <when value="single">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
61 <param format="fna" name="input1" type="data" label="Input sequence" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
62 </when>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
63 <when value="paired">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
64 <param format="fna" name="input1" type="data" label="Input sequence" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
65 <param format="fna" name="input2" type="data" label="Input sequence" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
66 </when>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
67 </conditional>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
68 <conditional name="params">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
69 <param name="settingsType" type="select" label="Parameter Settings" help="You can use the default settings or set custom values for the parameters.">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
70 <option value="preSet">Use Defaults</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
71 <option value="full">Full parameter list</option>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
72 </param>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
73 <when value="preSet" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
74 <!-- Full/advanced parameters. -->
abe73a62b59a Uploaded
subazini
parents:
diff changeset
75 <when value="full">
abe73a62b59a Uploaded
subazini
parents:
diff changeset
76 <param name="i" type="text" value="250" label="Insert size" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
77 <param name="d" type="text" value="50" label="standard deviation" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
78 <param name="r" type="text" value="0.001" label="substitutionrate" />
abe73a62b59a Uploaded
subazini
parents:
diff changeset
79 </when> <!-- full -->
abe73a62b59a Uploaded
subazini
parents:
diff changeset
80 </conditional> <!-- params -->
abe73a62b59a Uploaded
subazini
parents:
diff changeset
81
abe73a62b59a Uploaded
subazini
parents:
diff changeset
82 </inputs>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
83
abe73a62b59a Uploaded
subazini
parents:
diff changeset
84 <outputs>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
85 <data format="txt" name="output" label="outfile"/>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
86 </outputs>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
87 <help>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
88 **Stampy**
abe73a62b59a Uploaded
subazini
parents:
diff changeset
89
abe73a62b59a Uploaded
subazini
parents:
diff changeset
90 Stampy is a package for the mapping of short reads from illumina sequencing machines onto a reference genome (http://www.well.ox.ac.uk/project-stampy). Selected options used here are given below
abe73a62b59a Uploaded
subazini
parents:
diff changeset
91
abe73a62b59a Uploaded
subazini
parents:
diff changeset
92 ------
abe73a62b59a Uploaded
subazini
parents:
diff changeset
93
abe73a62b59a Uploaded
subazini
parents:
diff changeset
94 **Indexing usage**
abe73a62b59a Uploaded
subazini
parents:
diff changeset
95
abe73a62b59a Uploaded
subazini
parents:
diff changeset
96 *Building index*
abe73a62b59a Uploaded
subazini
parents:
diff changeset
97
abe73a62b59a Uploaded
subazini
parents:
diff changeset
98 stampy.py --species=human --assembly=hg18_ncbi36 -G hg18 /data/genomes/hg18/*.fa.gz
abe73a62b59a Uploaded
subazini
parents:
diff changeset
99
abe73a62b59a Uploaded
subazini
parents:
diff changeset
100 *Building hash*
abe73a62b59a Uploaded
subazini
parents:
diff changeset
101
abe73a62b59a Uploaded
subazini
parents:
diff changeset
102 stampy.py -g hg18 -H hg18
abe73a62b59a Uploaded
subazini
parents:
diff changeset
103
abe73a62b59a Uploaded
subazini
parents:
diff changeset
104 ------
abe73a62b59a Uploaded
subazini
parents:
diff changeset
105
abe73a62b59a Uploaded
subazini
parents:
diff changeset
106
abe73a62b59a Uploaded
subazini
parents:
diff changeset
107 **Alignment usage**
abe73a62b59a Uploaded
subazini
parents:
diff changeset
108
abe73a62b59a Uploaded
subazini
parents:
diff changeset
109 stampy.py options -g hg18 -h hg18 -M reads_1.fastq reads_2.fastq
abe73a62b59a Uploaded
subazini
parents:
diff changeset
110
abe73a62b59a Uploaded
subazini
parents:
diff changeset
111
abe73a62b59a Uploaded
subazini
parents:
diff changeset
112 ------
abe73a62b59a Uploaded
subazini
parents:
diff changeset
113
abe73a62b59a Uploaded
subazini
parents:
diff changeset
114 **Options - Description**
abe73a62b59a Uploaded
subazini
parents:
diff changeset
115
abe73a62b59a Uploaded
subazini
parents:
diff changeset
116 --insertsize
abe73a62b59a Uploaded
subazini
parents:
diff changeset
117
abe73a62b59a Uploaded
subazini
parents:
diff changeset
118 Set the mean insert size for paired-end reads (default: 250)
abe73a62b59a Uploaded
subazini
parents:
diff changeset
119
abe73a62b59a Uploaded
subazini
parents:
diff changeset
120 --insertsd=N
abe73a62b59a Uploaded
subazini
parents:
diff changeset
121
abe73a62b59a Uploaded
subazini
parents:
diff changeset
122 Set the standard deviation of the insert size distribution (default: 60)
abe73a62b59a Uploaded
subazini
parents:
diff changeset
123
abe73a62b59a Uploaded
subazini
parents:
diff changeset
124 --substitutionrate=S
abe73a62b59a Uploaded
subazini
parents:
diff changeset
125
abe73a62b59a Uploaded
subazini
parents:
diff changeset
126 Introduce an expected fraction S of Poisson-distributed substitutions (default: 0.001)
abe73a62b59a Uploaded
subazini
parents:
diff changeset
127
abe73a62b59a Uploaded
subazini
parents:
diff changeset
128
abe73a62b59a Uploaded
subazini
parents:
diff changeset
129 </help>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
130
abe73a62b59a Uploaded
subazini
parents:
diff changeset
131 </tool>
abe73a62b59a Uploaded
subazini
parents:
diff changeset
132