annotate sam_dump.xml @ 6:e4c21444a3ba

Add sniffer, clean up imports, register sniffable datatype.
author Matt Shirley <mdshw5@gmail.com>
date Thu, 13 Mar 2014 15:30:54 -0400
parents 548b3e8d7a0a
children 558a88cd49e4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
548b3e8d7a0a bump sam-dump version
Matt Shirley <mdshw5@gmail.com>
parents: 2
diff changeset
1 <tool id="sam_dump" name="Extract reads" version="1.1.2">
2
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
2 <description> in SAM format from NCBI SRA.</description>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
3 <command>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
4 sam-dump --log-level fatal
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
5 #if str( $region ) != "":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
6 --aligned-region $region
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
7 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
8 #if str( $matepairDist ) != "":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
9 --matepair-distance $matepairDist
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
10 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
11 #if str( $minMapq ) != "":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
12 --minmapq $minMapq
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
13 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
14 #if $header == "yes":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
15 --header
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
16 #else:
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
17 --no-header
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
18 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
19 #if str( $alignments ) == "both":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
20 --unaligned
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
21 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
22 #if str( $alignments ) == "unaligned":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
23 --unaligned-spots-only
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
24 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
25 #if (str( $primary ) == "yes") and (str ( $alignments != "unaligned") ):
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
26 --primary
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
27 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
28 #if str( $fastq ) == "yes":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
29 --fastq
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
30 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
31 #if $input.input_select == "file":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
32 $input.file
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
33 #elif $input.input_select == "accession_number":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
34 $input.accession
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
35 #elif $input.input_select == "text":
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
36 `cat $input.text`
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
37 #end if
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
38 > $output
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
39 </command>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
40 <version_string>sam-dump --version</version_string>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
41 <inputs>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
42 <conditional name="input">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
43 <param name="input_select" type="select" label="select input type">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
44 <option value="accession_number">SRR accession</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
45 <option value="file">SRA archive in current history</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
46 <option value="text">text file containing SRR accession</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
47 </param>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
48 <when value="file">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
49 <param format="sra" name="file" type="data" label="sra archive"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
50 </when>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
51 <when value="accession_number">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
52 <param format="text" name="accession" type="text" label="accession"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
53 </when>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
54 <when value="text">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
55 <param format="txt" name="text" type="data" label="text file"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
56 </when>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
57 </conditional>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
58 <param format="text" name="region" type="text" label="aligned region"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
59 <param format="text" name="matepairDist" type="text" label="mate-pair distance (from-to|unknown)"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
60 <param format="text" name="header" type="select" value="yes">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
61 <label>output SAM header</label>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
62 <option value="yes">Yes</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
63 <option value="no">No</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
64 </param>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
65 <param format="text" name="alignments" type="select" value="both">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
66 <label>aligned or unaligned reads</label>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
67 <option value="both">both</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
68 <option value="aligned">aligned only</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
69 <option value="unaligned">unaligned only</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
70 </param>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
71 <param format="text" name="primary" type="select" value="no">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
72 <label>only primary aligments</label>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
73 <option value="no">No</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
74 <option value="yes">Yes</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
75 </param>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
76 <param format="text" name="minMapq" type="text" label="minimum mapping quality"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
77 <param format="text" name="fastq" type="select" value="no">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
78 <label>output fastq</label>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
79 <option value="no">No</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
80 <option value="yes">Yes</option>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
81 </param>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
82 </inputs>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
83 <outputs>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
84 <data name="output" format="sam">
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
85 <change_format>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
86 <when input="fastq" value="yes" format="fastq"/>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
87 </change_format>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
88 </data>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
89 </outputs>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
90 <requirements>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
91 <requirement type="package" version="2.3.3-3">sra_toolkit</requirement>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
92 </requirements>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
93 <help>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
94 This tool extracts reads from sra archives using sam-dump.
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
95 Browse the NCBI SRA for SRR accessions at http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=studies.
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
96 The sam-dump program is developed at NCBI, and is available at: http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
97 Contact Matt Shirley at mdshw5@gmail.com for support and bug reports.
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
98 </help>
293927a46697 Move from test tool shed
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
99 </tool>