Mercurial > repos > matt-shirley > sra_tools

annotate sam_dump.xml @ 40:f1b83804013f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add option to take plaintext file with accession on one line
author Matt Shirley <mdshw5@gmail.com>
date Mon, 05 Aug 2013 09:40:26 -0400
parents 1d152e8cb375
children e64912394751
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
a0925f507352 bring pileup to parity with sam; fixed minMapq for sam
Matt Shirley <mdshw5@gmail.com>
parents: 37
diff changeset
1 <tool id="sam_dump" name="Extract reads" version="1.1.1">
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
2 <description> in SAM format from NCBI SRA.</description>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
3 <command>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
4 sam-dump --log-level fatal
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
5 #if str( $region ) != "":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
6 --aligned-region $region
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
7 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
8 #if str( $matepairDist ) != "":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
9 --matepair-distance $matepairDist
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
10 #end if
38
a0925f507352 bring pileup to parity with sam; fixed minMapq for sam
Matt Shirley <mdshw5@gmail.com>
parents: 37
diff changeset
11 #if str( $minMapq ) != "":
a0925f507352 bring pileup to parity with sam; fixed minMapq for sam
Matt Shirley <mdshw5@gmail.com>
parents: 37
diff changeset
12 --minmapq $minMapq
a0925f507352 bring pileup to parity with sam; fixed minMapq for sam
Matt Shirley <mdshw5@gmail.com>
parents: 37
diff changeset
13 #end if
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
14 #if $header == "yes":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
15 --header
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
16 #else:
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
17 --no-header
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
18 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
19 #if str( $alignments ) == "both":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
20 --unaligned
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
21 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
22 #if str( $alignments ) == "unaligned":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
23 --unaligned-spots-only
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
24 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
25 #if (str( $primary ) == "yes") and (str ( $alignments != "unaligned") ):
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
26 --primary
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
27 #end if
39
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
28 #if str( $fastq ) == "yes":
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
29 --fastq
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
30 #end if
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
31 #if $input.input_select == "file":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
32 $input.file
40
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
33 #elif $input.input_select == "accession_number":
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
34 $input.accession
40
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
35 #elif $input.input_select == "text":
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
36 $input.text
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
37 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
38 > $output
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
39 </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
40 <version_string>sam-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
41 <inputs>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
42 <conditional name="input">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
43 <param name="input_select" type="select" label="select input type">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
44 <option value="accession_number">SRR accession</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
45 <option value="file">SRA archive in current history</option>
40
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
46 <option value="text">text file containing SRR accession</option>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
47 </param>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
48 <when value="file">
40
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
49 <param format="sra" name="file" type="data" label="sra archive"/>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
50 </when>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
51 <when value="accession_number">
40
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
52 <param format="text" name="accession" type="text" label="accession"/>
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
53 </when>
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
54 <when value="text">
f1b83804013f add option to take plaintext file with accession on one line
Matt Shirley <mdshw5@gmail.com>
parents: 39
diff changeset
55 <param format="txt" name="text" type="txt" label="text file"/>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
56 </when>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
57 </conditional>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
58 <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: 22
diff changeset
59 <param format="text" name="matepairDist" type="text" label="mate-pair distance (from-to|unknown)"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
60 <param format="text" name="header" type="select" value="yes">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
61 <label>output SAM header</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
62 <option value="yes">Yes</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
63 <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
64 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
65 <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: 22
diff changeset
66 <label>aligned or unaligned reads</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
67 <option value="both">both</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
68 <option value="aligned">aligned only</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
69 <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
70 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
71 <param format="text" name="primary" type="select" value="no">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
72 <label>only primary aligments</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
73 <option value="no">No</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
74 <option value="yes">Yes</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
75 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
76 <param format="text" name="minMapq" type="text" label="minimum mapping quality"/>
39
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
77 <param format="text" name="fastq" type="select" value="no">
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
78 <label>output fastq</label>
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
79 <option value="no">No</option>
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
80 <option value="yes">Yes</option>
1d152e8cb375 add fastq output option to sam dump
Matt Shirley <mdshw5@gmail.com>
parents: 38
diff changeset
81 </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
82 </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
83 <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
84 <data format="sam" name="output"/>
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
85 </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
86 <requirements>
11
cdba74ec9eca updated sra_toolkit dependency in <requirements>
Matt Shirley <mdshw5@gmail.com>
parents: 0
diff changeset
87 <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
88 </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
89 <help>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
90 This tool extracts reads from sra archives using sam-dump.
21
d850324e82cf fix datatype reference, increment versions
Matt Shirley <mdshw5@gmail.com>
parents: 13
diff changeset
91 The sam-dump program is developed at NCBI, and is available at: http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.
d850324e82cf fix datatype reference, increment versions
Matt Shirley <mdshw5@gmail.com>
parents: 13
diff changeset
92 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
93 </help>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
94 </tool>