annotate tools/mira4/mira4_bait.xml @ 0:6a88b42ce6b9 draft

Uploaded v0.0.4, previously only on the TestToolShed
author peterjc
date Fri, 21 Nov 2014 06:42:56 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
1 <tool id="mira_4_0_bait" name="MIRA v4.0 mirabait" version="0.0.3">
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
2 <description>Filter reads using kmer matches</description>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
3 <requirements>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
4 <requirement type="binary">mirabait</requirement>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
5 <requirement type="package" version="4.0">MIRA</requirement>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
6 </requirements>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
7 <version_command interpreter="python">mira4_bait.py --version</version_command>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
8 <command interpreter="python">
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
9 mira4_bait.py $input_reads.ext $output_choice $strand_choice $kmer_length $min_occurence "$bait_file" "$input_reads" "$output_reads"
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
10 </command>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
11 <stdio>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
12 <!-- Assume anything other than zero is an error -->
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
13 <exit_code range="1:" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
14 <exit_code range=":-1" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
15 </stdio>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
16 <inputs>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
17 <param name="bait_file" type="data" format="fasta,fastq,mira" required="true" label="Bait file (what to look for)" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
18 <param name="input_reads" type="data" format="fasta,fastq,mira" required="true" label="Reads to search" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
19 <param name="output_choice" type="select" label="Output positive matches, or negative matches?">
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
20 <option value="pos">Just positive matches</option>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
21 <option value="neg">Just negative matches</option>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
22 </param>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
23 <param name="strand_choice" type="select" label="Check for matches on both strands?">
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
24 <option value="both">Check both strands</option>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
25 <option value="fwd">Just forward strand</option>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
26 </param>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
27 <param name="kmer_length" type="integer" value="31" min="1" max="32"
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
28 label="k-mer length" help="Maximum 32" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
29 <param name="min_occurence" type="integer" value="1" min="1"
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
30 label="Minimum k-mer occurence"
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
31 help="How many k-mer matches do you want per read? Minimum one" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
32 </inputs>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
33 <outputs>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
34 <data name="output_reads" format="input" metadata_source="input_reads"
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
35 label="$input_reads.name #if str($output_choice)=='pos' then 'matching' else 'excluding matches to' # $bait_file.name"/>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
36 </outputs>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
37 <tests>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
38 <test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
39 <param name="bait_file" value="tvc_bait.fasta" ftype="fasta" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
40 <param name="input_reads" value="tvc_mini.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
41 <output name="output_reads" file="tvc_mini_bait_pos.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
42 </test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
43 <test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
44 <param name="bait_file" value="tvc_bait.fasta" ftype="fasta" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
45 <param name="input_reads" value="tvc_mini.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
46 <param name="kmer_length" value="32" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
47 <param name="min_occurence" value="50" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
48 <output name="output_reads" file="tvc_mini_bait_strict.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
49 </test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
50 <test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
51 <param name="bait_file" value="tvc_bait.fasta" ftype="fasta" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
52 <param name="input_reads" value="tvc_mini.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
53 <param name="output_choice" value="neg" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
54 <output name="output_reads" file="tvc_mini_bait_neg.fastq" ftype="fastqsanger" />
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
55 </test>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
56 </tests>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
57 <help>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
58 **What it does**
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
59
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
60 Runs the ``mirabait`` utility from MIRA v4.0 to filter your input reads
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
61 according to whether or not they contain perfect kmer matches to your
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
62 bait file. By default this looks for 31-mers (kmers or *k*-mers where
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
63 the fragment length *k* is 31), and only requires a single matching kmer.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
64
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
65 The ``mirabait`` utility is useful in many applications and pipelines
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
66 outside of using the main MIRA tool for assembly or mapping.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
67
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
68 .. class:: warningmark
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
69
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
70 Note ``mirabait`` cannot be used on protein (amino acid) sequences.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
71
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
72 **Example Usage**
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
73
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
74 To remove over abundant entries like rRNA sequences, run ``mirabait`` with
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
75 known rRNA sequences as the bait and select the *negative* matches.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
76
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
77 To do targeted assembly by fishing out reads belonging to a gene and just
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
78 assemble these, run ``mirabait`` with the gene of interest as the bait and
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
79 select the *positive* matches.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
80
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
81 To iteratively reconstruct mitochondria you could start by fishing out reads
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
82 matching any known mitochondrial sequence, assembly those, and repeat.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
83
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
84
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
85 **Notes on paired read**
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
86
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
87 .. class:: warningmark
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
88
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
89 While MIRA4 is aware of many read naming conventions to identify paired read
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
90 partners, the ``mirabait`` tool considers each read in isolation. Applying
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
91 it to paired read files may leave you with orphaned reads.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
92
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
93
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
94 **Citation**
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
95
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
96 If you use this Galaxy tool in work leading to a scientific publication please
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
97 cite the following papers:
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
98
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
99 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
100 Galaxy tools and workflows for sequence analysis with applications
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
101 in molecular plant pathology. PeerJ 1:e167
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
102 http://dx.doi.org/10.7717/peerj.167
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
103
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
104 Bastien Chevreux, Thomas Wetter and Sándor Suhai (1999).
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
105 Genome Sequence Assembly Using Trace Signals and Additional Sequence Information.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
106 Computer Science and Biology: Proceedings of the German Conference on Bioinformatics (GCB) 99, pp. 45-56.
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
107 http://www.bioinfo.de/isb/gcb99/talks/chevreux/main.html
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
108
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
109 This wrapper is available to install into other Galaxy Instances via the Galaxy
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
110 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/mira4_assembler
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
111 </help>
6a88b42ce6b9 Uploaded v0.0.4, previously only on the TestToolShed
peterjc
parents:
diff changeset
112 </tool>