Mercurial > repos > matt-shirley > sra_tools

annotate fastq_dump.xml @ 42:ed3866e8e3b8 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
auto datatype for sam dump
author Matt Shirley <mdshw5@gmail.com>
date Mon, 05 Aug 2013 10:11:15 -0400
parents 4da2d7f0128e
children 88a13a2fd23f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
1 <tool id="fastq_dump" name="Extract reads" version="1.1.0">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
2 <description> from NCBI SRA.</description>
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
3 <command>
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
4 fastq-dump --log-level fatal
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
5 #if $input.input_select == "file":
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
6 --accession '${input.file.name}'
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
7 #else:
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
8 --accession $input.accession
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
9 #end if
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
10 --defline-seq '@\$sn[_\$rn]/\$ri'
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
11 --stdout
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
12 #if $split == "yes":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
13 --split-spot
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
14 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
15 #if str( $alignments ) == "aligned":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
16 --aligned
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
17 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
18 #if str( $alignments ) == "unaligned":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
19 --unaligned
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
20 #end if
36
b5274b0e61bc variable typos
Matt Shirley <mdshw5@gmail.com>
parents: 35
diff changeset
21 #if str( $minID ) != "":
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
22 --minSpotId $minID
35
a93bb9eb93c5 properly end conditional statements
Matt Shirley <mdshw5@gmail.com>
parents: 34
diff changeset
23 #end if
36
b5274b0e61bc variable typos
Matt Shirley <mdshw5@gmail.com>
parents: 35
diff changeset
24 #if str( $maxID ) != "":
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
25 --maxSpotId $maxID
35
a93bb9eb93c5 properly end conditional statements
Matt Shirley <mdshw5@gmail.com>
parents: 34
diff changeset
26 #end if
36
b5274b0e61bc variable typos
Matt Shirley <mdshw5@gmail.com>
parents: 35
diff changeset
27 #if str( $minlen ) != "":
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
28 --minReadLen $minlen
35
a93bb9eb93c5 properly end conditional statements
Matt Shirley <mdshw5@gmail.com>
parents: 34
diff changeset
29 #end if
36
b5274b0e61bc variable typos
Matt Shirley <mdshw5@gmail.com>
parents: 35
diff changeset
30 #if str( $readfilter ) != "":
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
31 --read-filter $readfilter
35
a93bb9eb93c5 properly end conditional statements
Matt Shirley <mdshw5@gmail.com>
parents: 34
diff changeset
32 #end if
36
b5274b0e61bc variable typos
Matt Shirley <mdshw5@gmail.com>
parents: 35
diff changeset
33 #if str( $region ) != "":
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
34 --aligned-region $region
35
a93bb9eb93c5 properly end conditional statements
Matt Shirley <mdshw5@gmail.com>
parents: 34
diff changeset
35 #end if
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
36 #if str( $spotgroups ) != "":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
37 --spot-groups $spotgroups
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
38 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
39 #if str( $matepairDist ) != "":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
40 --matepair-distance $matepairDist
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
41 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
42 #if $clip == "yes":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
43 --clip
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
44 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
45 #if str( $outputformat ) == "fasta":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
46 --fasta
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
47 #end if
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
48 #if $input.input_select=="file":
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
49 $input.file
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
50 #else:
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
51 $input.accession
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
52 #end if
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
53 > $output
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
54 </command>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
55 <version_string>fastq-dump --version</version_string>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
56 <inputs>
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
57 <conditional name="input">
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
58 <param name="input_select" type="select" label="select input type">
27
2295c666e6ce debug prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 26
diff changeset
59 <option value="accession_number">SRR accession</option>
2295c666e6ce debug prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 26
diff changeset
60 <option value="file">SRA archive in current history</option>
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
61 </param>
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
62 <when value="file">
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
63 <param format="sra" name="file" type="data" label="sra archive"/>
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
64 </when>
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
65 <when value="accession_number">
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
66 <param format="text" name="accession" type="text" label="accession"/>
26
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
67 </when>
5f57967aac3e implement prefetch caching and accession input for fastq_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
68 </conditional>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
69 <param format="text" name="minID" type="text" label="minimum spot ID"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
70 <param format="text" name="maxID" type="text" label="maximum spot ID"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
71 <param format="text" name="minlen" type="text" label="minimum read length"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
72 <param format="text" name="split" type="select" value="yes">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
73 <label>split spot by read pairs</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
74 <option value="yes">Yes</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
75 <option value="no">No</option>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
76 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
77 <param format="text" name="alignments" type="select" value="both">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
78 <label>aligned or unaligned reads</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
79 <option value="both">both</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
80 <option value="aligned">aligned only</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
81 <option value="unaligned">unaligned only</option>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
82 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
83 <param format="text" name="region" type="text" label="aligned region"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
84 <param format="text" name="matepairDist" type="text" label="mate-pair distance (from-to|unknown)"/>
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
85 <param format="text" name="readfilter" type="select" value="">
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
86 <label>filter by value</label>
34
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
87 <option value="">None</option>
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
88 <option value="pass">pass</option>
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
89 <option value="reject">reject</option>
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
90 <option value="criteria">criteria</option>
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
91 <option value="redacted">redacted</option>
7803126704c6 exposed many more options for fastq-dump
Matt Shirley <mdshw5@gmail.com>
parents: 33
diff changeset
92 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
93 <param name="outputformat" type="select" label="select output format">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
94 <option value="fastqsanger">fastq</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
95 <option value="fasta">fasta</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
96 </param>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
97 <param format="text" name="spotgroups" type="text" label="filter by spot-groups"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
98 <param format="text" name="clip" type="select" value="no">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
99 <label>apply left and right clips</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
100 <option value="no">No</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
101 <option value="yes">Yes</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
102 </param>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
103 </inputs>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
104 <outputs>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
105 <data format="fastq" name="output">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
106 <change_format>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
107 <when input="outputformat" value="fasta" format="fasta" />
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
108 </change_format>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
109 </data>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
110 </outputs>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
111 <stdio>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
112 <exit_code range="127" level="fatal" description="Could not locate fastq-dump binary"/>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
113 </stdio>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
114 <requirements>
11
cdba74ec9eca updated sra_toolkit dependency in <requirements>
Matt Shirley <mdshw5@gmail.com>
parents: 1
diff changeset
115 <requirement type="package" version="2.3.2-4">sra_toolkit</requirement>
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
116 </requirements>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
117 <help>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 36
diff changeset
118 This tool extracts reads from SRA archives using fastq-dump.
22
423f3eb06428 more fixes for sra datatype, added sra_pileup
Matt Shirley <mdshw5@gmail.com>
parents: 21
diff changeset
119 The fastq-dump program is developed at NCBI, and is available at: http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.
423f3eb06428 more fixes for sra datatype, added sra_pileup
Matt Shirley <mdshw5@gmail.com>
parents: 21
diff changeset
120 Contact Matt Shirley at mdshw5@gmail.com for support and bug reports.
0
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
121 </help>
ffdd41766195 Initial version - still need to test if datatype works correctly, and implement scripted download of SRA binaries.
matt-shirley <mdshw5@gmail.com>
parents:
diff changeset
122 </tool>