annotate sam_dump.xml @ 37:4da2d7f0128e draft

Exposed more options for fastq_dump and sam_dump
author Matt Shirley <mdshw5@gmail.com>
date Thu, 01 Aug 2013 13:57:27 -0400
parents 423f3eb06428
children a0925f507352
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: 22
diff changeset
1 <tool id="sam_dump" name="Extract reads" version="1.1.0">
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
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
11 #if $header == "yes":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
12 --header
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
13 #else:
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
14 --no-header
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
15 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
16 #if str( $alignments ) == "both":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
17 --unaligned
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 ) == "unaligned":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
20 --unaligned-spots-only
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( $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
23 --primary
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 $input.input_select == "file":
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
26 $input.file
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
27 #else:
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
28 $input.accession
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
29 #end if
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
30 > $output
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
31 </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
32 <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
33 <inputs>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
34 <conditional name="input">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
35 <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
36 <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
37 <option value="file">SRA archive in current history</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
38 </param>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
39 <when value="file">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
40 <param format="sra" name="file" type="data" label="sra archive"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
41 </when>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
42 <when value="accession_number">
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
43 <param format="text" name="accession" type="text" label="accession"/>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
44 </when>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
45 </conditional>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
46 <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
47 <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
48 <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
49 <label>output SAM header</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
50 <option value="yes">Yes</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
51 <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
52 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
53 <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
54 <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
55 <option value="both">both</option>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
56 <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
57 <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
58 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
59 <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
60 <label>only primary aligments</label>
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
61 <option value="no">No</option>
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>
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
63 </param>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
64 <param format="text" name="minMapq" type="text" label="minimum mapping quality"/>
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
65 </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
66 <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
67 <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
68 </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
69 <requirements>
11
cdba74ec9eca updated sra_toolkit dependency in <requirements>
Matt Shirley <mdshw5@gmail.com>
parents: 0
diff changeset
70 <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
71 </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
72 <help>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
73 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
74 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
75 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
76 </help>
37
4da2d7f0128e Exposed more options for fastq_dump and sam_dump
Matt Shirley <mdshw5@gmail.com>
parents: 22
diff changeset
77 </tool>