annotate bam_dump.xml @ 29:ce2bb7841f17 default tip

Fix for https://github.com/mdshw5/sra-tools-galaxy/issues/1
author Matt Shirley <mdshw5@gmail.com>
date Tue, 07 Apr 2015 09:09:23 -0400
parents fdc981664a43
children
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>
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
4 sam-dump --log-level fatal --disable-multithreading
27
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
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
14 #if str( $header ) == "yes":
27
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 #end if
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
33 | samtools view -Sb - 2> /dev/null > $output
27
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
34 </command>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
35 <version_string>sam-dump --version</version_string>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
36 <inputs>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
37 <conditional name="input">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
38 <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
39 <option value="accession_number">SRR accession</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
40 <option value="file">SRA archive in current history</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
41 </param>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
42 <when value="file">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
43 <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
44 </when>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
45 <when value="accession_number">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
46 <param format="text" name="accession" type="text" label="accession"/>
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 </conditional>
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
49 <param format="text" name="region" type="text" label="aligned region (chr:start-end)"/>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
50 <param format="text" name="matepairDist" type="text" label="mate-pair distance (from-to)"/>
27
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
51 <param format="text" name="header" type="select" value="yes">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
52 <label>output BAM header</label>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
53 <option value="yes">Yes</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
54 <option value="no">No</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
55 </param>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
56 <param format="text" name="alignments" type="select" value="both">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
57 <label>aligned or unaligned reads</label>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
58 <option value="both">both</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
59 <option value="aligned">aligned only</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
60 <option value="unaligned">unaligned only</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="primary" type="select" value="no">
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
63 <label>only primary aligments</label>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
64 <option value="no">No</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
65 <option value="yes">Yes</option>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
66 </param>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
67 <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
68 </inputs>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
69 <outputs>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
70 <data name="output" format="bam"/>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
71 </outputs>
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
72 <stdio>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
73 <exit_code range="127" level="fatal" description="Could not locate sam-dump and/or samtools binary"/>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
74 </stdio>
27
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
75 <requirements>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
76 <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
77 <requirement type="package" version="1.2">samtools</requirement>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
78 </requirements>
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
79 <tests>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
80 <test>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
81 <param name="input_select" value="accession_number"/>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
82 <param name="accession" value="SRR925743"/>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
83 <param name="region" value="17:41243452-41277500"/>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
84 <output name="output" file="bam_dump_result.bam" ftype="bam" />
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
85 </test>
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
86 </tests>
27
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
87 <help>
28
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
88 This tool extracts reads from sra archives using sam-dump.
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
89 Browse the NCBI SRA for SRR accessions at http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=studies.
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
90 The sam-dump program is developed at NCBI, and is available at: http://github.com/ncbi/sra-tools
fdc981664a43 Update to most recent GitHub version passing tests.
Matt Shirley <mdshw5@gmail.com>
parents: 27
diff changeset
91 Please submit inquiries and bug reports to http://github.com/mdshw5/sra-tools-galaxy.
27
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
92 </help>
8be4f23d1018 Add bam-dump and test data.
Matt Shirley <mdshw5@gmail.com>
parents:
diff changeset
93 </tool>