annotate bam_dump.xml @ 27:8be4f23d1018

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