Mercurial > repos > peterjc > mira4_assembler

annotate tools/mira4/mira4_mapping.xml @ 19:8487d70e82aa draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.3 preview 1, target MIRA v4.0.2
author peterjc
date Wed, 21 May 2014 06:56:06 -0400
parents 381aa262c8cb
children aeb3e35f8236
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
8487d70e82aa Uploaded v0.0.3 preview 1, target MIRA v4.0.2
peterjc
parents: 18
diff changeset
1 <tool id="mira_4_0_mapping" name="MIRA v4.0 mapping" version="0.0.3">
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
2 <description>Maps Sanger, Roche 454, Solexa/Illumina, Ion Torrent and PacBio reads</description>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
3 <requirements>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
4 <requirement type="binary">mira</requirement>
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
5 <requirement type="binary">miraconvert</requirement>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
6 <requirement type="package" version="4.0">MIRA</requirement>
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
7 <requirement type="binary">samtools</requirement>
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
8 <requirement type="package" version="0.1.19">samtools</requirement>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
9 </requirements>
5
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
10 <version_command interpreter="python">mira4.py --version</version_command>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
11 <command interpreter="python">
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
12 mira4.py "$manifest" "$out_maf" "$out_bam" "$out_fasta" "$out_log"
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
13 </command>
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
14 <stdio>
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
15 <!-- Assume anything other than zero is an error -->
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
16 <exit_code range="1:" />
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
17 <exit_code range=":-1" />
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
18 </stdio>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
19 <inputs>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
20 <param name="job_type" type="select" label="Assembly type">
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
21 <option value="genome">Genome</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
22 <option value="est">EST (transcriptome)</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
23 </param>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
24 <param name="job_quality" type="select" label="Assembly quality grade">
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
25 <option value="accurate">Accurate</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
26 <option value="draft">Draft</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
27 </param>
15
b0ffe0e7282b Uploaded v0.0.2 preview 7, fixed bash syntax error
peterjc
parents: 13
diff changeset
28 <!-- TODO? Allow technology type for references? -->
b0ffe0e7282b Uploaded v0.0.2 preview 7, fixed bash syntax error
peterjc
parents: 13
diff changeset
29 <!-- TODO? Allow strain settings for reference(s) and reads? -->
b0ffe0e7282b Uploaded v0.0.2 preview 7, fixed bash syntax error
peterjc
parents: 13
diff changeset
30 <!-- TODO? Use a repeat to allow for multi-strain references? -->
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
31 <!-- TODO? Add strain to the mapping read groups? -->
15
b0ffe0e7282b Uploaded v0.0.2 preview 7, fixed bash syntax error
peterjc
parents: 13
diff changeset
32 <param name="references" type="data" format="fasta,fastq,mira" multiple="true" required="true" label="Backbone reference file(s)"
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
33 help="Multiple files allowed, for example one FASTA file per chromosome or plasmid." />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
34 <param name="strain_setup" type="select" label="Strain configuration (reference vs reads)">
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
35 <option value="default">Different strains - mapping reads onto a related reference ('StrainX' vs 'ReferenceStrain')</option>
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
36 <option value="same">Same strain - mapping reads from same reference (all 'StrainX')</option>
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
37 </param>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
38 <repeat name="read_group" title="Read Group" min="1">
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
39 <param name="technology" type="select" label="Read technology">
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
40 <option value="solexa">Solexa/Illumina</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
41 <option value="sanger">Sanger cappillary sequencing</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
42 <option value="454">Roche 454</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
43 <option value="iontor">Ion Torrent</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
44 <option value="pcbiolq">PacBio low quality (raw)</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
45 <option value="pcbiohq">PacBio high quality (corrected)</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
46 <option value="text">Synthetic reads (database entries, consensus sequences, artifical reads, etc)</option>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
47 </param>
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
48 <conditional name="segments">
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
49 <param name="type" type="select" label="Are these paired reads?">
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
50 <option value="paired">Paired reads</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
51 <option value="none">Single reads or not relevant (e.g. primer walking with Sanger capillary sequencing)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
52 </param>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
53 <when value="paired">
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
54 <param name="placement" type="select" label="Pairing type (segment placing)">
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
55 <option value="FR">---&gt; &lt;--- (e.g. Sanger capillary or Solexa/Illumina paired-end library)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
56 <option value="RF">&lt;--- ---&gt; (e.g. Solexa/Illumina mate-pair library)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
57 <option value="SB">2---&gt; 1---&gt; (e.g. Roche 454 paired-end libraries or IonTorrent long-mate; see note)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
58 </param>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
59 <param name="naming" type="select" label="Pair naming convention">
7
902f01c1084b Uploaded v0.0.1 preview 7, with mirabait wrapper
peterjc
parents: 6
diff changeset
60 <option value="solexa">Solexa/Illumina (using '/1' and '/2' suffixes, or later Illumina colon system)</option>
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
61 <option value="FR">Forward/Reverse scheme (using '.f*' and '.r*' suffixes)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
62 <option value="tigr">TIGR scheme (using 'TF*' and 'TR*' suffixes)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
63 <option value="sanger">Sanger scheme (see notes)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
64 <option value="stlouis">St. Louis scheme (see notes)</option>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
65 </param>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
66 </when>
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
67 <when value="none" /><!-- no further questions -->
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
68 </conditional>
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
69 <param name="filenames" type="data" format="fastq,mira" multiple="true" required="true" label="Read file(s)"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
70 help="Multiple files allowed, for example paired reads can be given as two files (MIRA looks at read names to identify pairs)." />
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
71 </repeat>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
72 </inputs>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
73 <outputs>
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
74 <data name="out_fasta" format="fasta" label="MIRA #if str($strain_setup)=='same' then 'same strain' else 'reference' # mapping contigs (FASTA)" />
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
75 <data name="out_bam" format="bam" label="MIRA #if str($strain_setup)=='same' then 'same strain' else 'reference' # mapping assembly (BAM)" />
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
76 <data name="out_maf" format="mira" label="MIRA #if str($strain_setup)=='same' then 'same strain' else 'reference' # mapping assembly" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
77 <data name="out_log" format="txt" label="MIRA #if str($strain_setup)=='same' then 'same strain' else 'reference' # mapping log" />
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
78 </outputs>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
79 <configfiles>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
80 <configfile name="manifest">
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
81 project = MIRA
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
82 job = mapping,${job_type},${job_quality}
19
8487d70e82aa Uploaded v0.0.3 preview 1, target MIRA v4.0.2
peterjc
parents: 18
diff changeset
83 parameters = -NW:cmrnl=no -DI:trt=/tmp -OUT:orc=no
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
84 ## -GE:not is short for -GENERAL:number_of_threads and using one (1)
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
85 ## can be useful for repeatability of assemblies and bug hunting.
13
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
86 ## This is overriden by the command line -t switch which is easier
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
87 ## to set from within Galaxy.
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
88 ##
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
89 ## -NW:cmrnl is short for -NAG_AND_WARN:check_maxreadnamelength
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
90 ## and without this MIRA aborts with read names over 40 characters
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
91 ## due to limitations of some downstream tools.
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
92 ##
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
93 ## -DI:trt is short for -DIRECTORY:tmp_redirected_to and should
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
94 ## point to a local hard drive (not something like NFS on network).
18
381aa262c8cb Uploaded v0.0.2 preview 10, override /tmp via environment variable
peterjc
parents: 17
diff changeset
95 ## We replace /tmp with an environment variable via mira4.py
19
8487d70e82aa Uploaded v0.0.3 preview 1, target MIRA v4.0.2
peterjc
parents: 18
diff changeset
96 ##
8487d70e82aa Uploaded v0.0.3 preview 1, target MIRA v4.0.2
peterjc
parents: 18
diff changeset
97 ## -OUT:orc=no is short for -OUTPUT:output_result_caf=no
8487d70e82aa Uploaded v0.0.3 preview 1, target MIRA v4.0.2
peterjc
parents: 18
diff changeset
98 ## which turns off an output file we don't want anyway.
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
99
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
100 ##This bar goes into the manifest as a comment line
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
101 #------------------------------------------------------------------------------
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
102
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
103 readgroup
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
104 is_reference
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
105 #if str($strain_setup)=="same"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
106 strain = StrainX
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
107 #end if
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
108 #for $f in $references
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
109 ##Must now map Galaxy datatypes to MIRA file types...
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
110 #if $f.ext.startswith("fastq")
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
111 ##MIRA doesn't like fastqsanger etc, just plain old fastq:
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
112 data = fastq::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
113 #elif $f.ext == "mira"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
114 ##We're calling *.maf the "mira" format in Galaxy (name space collision)
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
115 data = maf::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
116 #elif $f.ext == "fasta"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
117 ##We're calling MIRA with the file type as "fna" as otherwise it wants quals
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
118 data = fna::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
119 #else
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
120 ##Currently don't expect anything else...
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
121 data = ${f.ext}::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
122 #end if
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
123 #end for
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
124 #for $rg in $read_group
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
125
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
126 ##This bar goes into the manifest as a comment line
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
127 #------------------------------------------------------------------------------
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
128
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
129 readgroup
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
130 technology = ${rg.technology}
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
131 #if str($strain_setup)=="same"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
132 ##This is perhaps redundant as MIRA defaults to StrainX for the reads:
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
133 strain = StrainX
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
134 #end if
5
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
135 ##Record the segment placement (if any)
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
136 #if str($rg.segments.type) == "paired"
13
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
137 segment_placement = ${rg.segments.placement}
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
138 segment_naming = ${rg.segments.naming}
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
139 #end if
13
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
140 ##if str($rg.segments.type) == "none"
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
141 ##MIRA4 manual says use segment_placement = unknown or ? for unpaired data
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
142 ##but this stopped working in MIRA 4.0 RC5 and 4.0 (final). See:
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
143 ##http://www.freelists.org/post/mira_talk/Unpaired-reads-and-segment-placement--or-unknown
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
144 ##segment_placement = ?
7fcabeeca5df Uploaded v0.0.2 preview 5, fixes for MIRA 4.0 (final), more verbose error if $MIRA4 path wrong
peterjc
parents: 9
diff changeset
145 ##end if
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
146 ##MIRA will accept multiple filenames on one data line, or multiple data lines
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
147 #for $f in $rg.filenames
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
148 ##Must now map Galaxy datatypes to MIRA file types...
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
149 #if $f.ext.startswith("fastq")
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
150 ##MIRA doesn't like fastqsanger etc, just plain old fastq:
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
151 data = fastq::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
152 #elif $f.ext == "mira"
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
153 ##We're calling *.maf the "mira" format in Galaxy (name space collision)
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
154 data = maf::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
155 #else
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
156 ##Currently don't expect anything else...
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
157 data = ${f.ext}::$f
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
158 #end if
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
159 #end for
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
160 #end for
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
161 </configfile>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
162 </configfiles>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
163 <tests>
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
164 <test>
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
165 <param name="job_type" value="genome" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
166 <param name="job_quality" value="accurate" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
167 <param name="references" value="tvc_contigs.fasta" ftype="fasta" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
168 <param name="strain_setup" value="default" />
17
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
169 <param name="type" value="none" />
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
170 <param name="filenames" value="tvc_mini.fastq" ftype="fastqsanger" />
17
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
171 <output name="out_fasta" file="tvc_map_ref_strain.fasta" ftype="fasta" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
172 <output name="out_bam" file="empty_file.dat" compare="contains" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
173 <output name="out_maf" file="empty_file.dat" compare="contains" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
174 <output name="out_log" file="empty_file.dat" compare="contains" />
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
175 </test>
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
176 <test>
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
177 <param name="job_type" value="genome" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
178 <param name="job_quality" value="accurate" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
179 <param name="references" value="tvc_contigs.fasta" ftype="fasta" />
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
180 <param name="strain_setup" value="same" />
17
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
181 <param name="type" value="none" />
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
182 <param name="filenames" value="tvc_mini.fastq" ftype="fastqsanger" />
17
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
183 <output name="out_fasta" file="tvc_map_same_strain.fasta" ftype="fasta" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
184 <output name="out_bam" file="empty_file.dat" compare="contains" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
185 <output name="out_maf" file="empty_file.dat" compare="contains" />
5bbaa930d7fa Uploaded v0.0.2 preview 9, more functional tests
peterjc
parents: 15
diff changeset
186 <output name="out_log" file="empty_file.dat" compare="contains" />
4
df86ed992a1b Uploaded preview 4, lots of work on mapping
peterjc
parents: 0
diff changeset
187 </test>
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
188 </tests>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
189 <help>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
190
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
191 **What it does**
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
192
9
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
193 Runs MIRA v4.0 in mapping mode, collects the output, generates a sorted BAM
302d13490b23 Uploaded v0.0.2 preview 1, BAM output
peterjc
parents: 7
diff changeset
194 file, and throws away all the temporary files.
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
195
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
196 MIRA is an open source assembly tool capable of handling sequence data from
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
197 a range of platforms (Sanger capillary, Solexa/Illumina, Roche 454, Ion Torrent
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
198 and also PacBio).
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
199
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
200 It is particularly suited to small genomes such as bacteria.
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
201
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
202
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
203 **Notes on paired reads**
5
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
204
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
205 .. class:: warningmark
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
206
6
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
207 MIRA uses read naming conventions to identify paired read partners
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
208 (and does not care about their order in the input files). In most cases,
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
209 the Solexa/Illumina setting is fine. For Sanger capillary sequencing,
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
210 you may need to rename your reads to match one of the standard conventions
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
211 supported by MIRA. For Roche 454 or Ion Torrent the appropriate settings
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
212 depend on how the FASTQ file was produced:
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
213
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
214 * If using Roche's ``sffinfo`` or older versions of ``sff_extract``
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
215 to convert SFF files to FASTQ, your reads will probably have the
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
216 ``---&gt; &lt;---`` orientation and use the ``.f`` and ``.r``
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
217 suffixes (FR naming).
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
218
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
219 * If using a recent version of ``sff_extract``, then the ``/1`` and ``/2``
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
220 suffixes are used (Solexa/Illumina style naming) and the original
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
221 ``2---&gt; 1---&gt;`` orientation is preserved.
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
222
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
223 The reason for this is the raw data for Roche 454 and Ion Torrent paired-end
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
224 libraries sequences a circularised fragment such that the raw data begins
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
225 with the end of the fragment, a linker, then the start of the fragment.
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
226 This means both the start and end are sequenced from the same strand, and
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
227 have the orientation ``2---&gt; 1---&gt;``. However, in order to use the data
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
228 with traditional tools expecting Sanger capillary style ``---&gt; &lt;---``
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
229 orientation it was common to reverse complement one of the pair to mimic this.
626d5cfd01aa Uploaded v0.0.1 preview 6, support for fragment length (using mira4_validator.py)
peterjc
parents: 5
diff changeset
230
5
ffefb87bd414 Uploaded v0.0.1 preview 5, using MIRA 4.0 RC4, supports segment_placement (pairing type)
peterjc
parents: 4
diff changeset
231
0
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
232 **Citation**
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
233
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
234 If you use this Galaxy tool in work leading to a scientific publication please
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
235 cite the following papers:
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
236
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
237 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
238 Galaxy tools and workflows for sequence analysis with applications
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
239 in molecular plant pathology. PeerJ 1:e167
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
240 http://dx.doi.org/10.7717/peerj.167
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
241
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
242 Bastien Chevreux, Thomas Wetter and Sándor Suhai (1999).
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
243 Genome Sequence Assembly Using Trace Signals and Additional Sequence Information.
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
244 Computer Science and Biology: Proceedings of the German Conference on Bioinformatics (GCB) 99, pp. 45-56.
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
245 http://www.bioinfo.de/isb/gcb99/talks/chevreux/main.html
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
246
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
247 This wrapper is available to install into other Galaxy Instances via the Galaxy
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
248 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/mira4_assembler
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
249 </help>
32f693f6e741 Uploaded v0.0.1 preview0, very much a work in progress, primarily checking mira_datatypes dependency
peterjc
parents:
diff changeset
250 </tool>