annotate sam_dump.xml @ 22:fe99dc15b7af draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 21f935ba50d3e4b455246c681e54d5c57c67032f"
author iuc
date Fri, 03 Sep 2021 16:17:17 +0000
parents b50c21c6e6bb
children 6669afa92957
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
b50c21c6e6bb "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 3c5c7587a9e8f4177db5ff1390b7e29cb190eb72"
iuc
parents: 19
diff changeset
1 <tool id="sam_dump" name="Download and Extract Reads in BAM" version="@VERSION@+galaxy0" profile="18.01">
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
2 <description>format from NCBI SRA</description>
22
fe99dc15b7af "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 21f935ba50d3e4b455246c681e54d5c57c67032f"
iuc
parents: 20
diff changeset
3 <expand macro="bio_tools"/>
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
4 <macros>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
5 <import>sra_macros.xml</import>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
6 </macros>
15
54366e4d692a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
7 <expand macro="requirements">
54366e4d692a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
8 <requirement type="package" version="1.10">samtools</requirement>
54366e4d692a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
9 </expand>
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
10 <version_command>sam-dump --version</version_command>
4
de3b6a854c0a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4091428e9e28ca06263bc00cdf938d20f620aa4d
iuc
parents: 3
diff changeset
11 <command detect_errors="exit_code">
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
12 <![CDATA[
17
37f09413ddbf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 15
diff changeset
13 @COPY_CONFIGFILE@
13
74dd3d0a33d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 686710a7d313b828f1daed20c4055479727f2d91
iuc
parents: 10
diff changeset
14 @SET_ACCESSIONS@
1
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
15
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
16 ## Do not use prefetch if region is specified, to avoid downloading
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
17 ## the complete sra file.
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
18
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
19 #if $input.input_select == "file":
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
20 sam-dump --log-level fatal '${input.file.name}'
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
21 #else:
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
22 #if ( str( $adv.region ) == "" ):
15
54366e4d692a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
23 prefetch -X 200000000 "\$acc" &&
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
24 #end if
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
25 sam-dump --log-level fatal --disable-multithreading
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
26 #end if
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
27
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
28 #if str( $adv.region ) != "":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
29 --aligned-region '$adv.region'
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
30 #end if
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
31 #if str( $adv.matepairDist ) != "":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
32 --matepair-distance '$adv.matepairDist'
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
33 #end if
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
34 #if str( $adv.minMapq ) != "":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
35 --min-mapq '$adv.minMapq'
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
36 #end if
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
37 --header
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
38 #if str( $adv.alignments ) == "both":
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
39 --unaligned
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
40 #end if
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
41
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
42 #if str( $adv.alignments ) == "unaligned":
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
43 --unaligned-spots-only
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
44 #end if
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
45 #if (str( $adv.primary ) == "yes") and (str ( $adv.alignments != "unaligned") ):
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
46 --primary
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
47 #end if
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
48 #if $input.input_select == "file":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
49 '$input.file'
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
50 #elif $input.input_select == "accession_number":
1
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
51 "\$acc"
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
52 #elif $input.input_select=="file_list":
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
53 "\$acc"
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
54 #end if
2
6aa2efbe5920 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4e83a7f6d542cd3129eb14a142f74c127f91d026
iuc
parents: 1
diff changeset
55
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
56 #if str( $outputformat ) == "bam":
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
57 | samtools view -Sb - 2> /dev/null
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
58 #end if
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
59 #if $input.input_select == "file":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
60 > '$output_file'
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
61 #elif $input.input_select == "accession_number":
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
62 > '$output_accession' )
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
63 #end if
1
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
64
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
65 #if $input.input_select=="file_list":
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
66 #if str( $outputformat ) == "bam":
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
67 > "\$acc.bam"
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
68 #elif str( $outputformat ) == "sam":
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
69 > "\$acc.sam"
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
70 #end if
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
71 ) ; done
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
72 #end if
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
73
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
74 ]]>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
75 </command>
17
37f09413ddbf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 15
diff changeset
76 <expand macro="configfile_hack"/>
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
77 <inputs>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
78 <expand macro="input_conditional"/>
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
79 <param name="outputformat" type="select" display="radio" label="select output format" help="In vast majority of cases you want to download data in bam format. It is more compact and is accepted by all downstream tools.">
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
80 <option value="bam">bam</option>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
81 <option value="sam">sam</option>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
82 </param>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
83 <section name="adv" title="Advanced Options" expanded="False">
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
84 <expand macro="alignments"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
85 <expand macro="region"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
86 <expand macro="matepairDist"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
87 <param name="primary" type="select" value="no">
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
88 <label>only primary aligments</label>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
89 <option value="no">No</option>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
90 <option value="yes">Yes</option>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
91 </param>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
92 <expand macro="minMapq"></expand>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
93 </section>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
94 </inputs>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
95 <outputs>
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
96 <collection name="output_collection" type="list" label="SAM/BAM data (fastq-dump)">
1
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
97 <filter>input['input_select'] == "file_list"</filter>
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
98 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.bam" directory="." ext='bam'/>
069a879beef7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 8550e0c7389533bebc75d7a93b89a3e59fe77bcd
iuc
parents: 0
diff changeset
99 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.sam" directory="." ext='sam'/>
2
6aa2efbe5920 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4e83a7f6d542cd3129eb14a142f74c127f91d026
iuc
parents: 1
diff changeset
100 </collection>
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
101 <data name="output_accession" format="bam" label="${input.accession} (sam-dump)">
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
102 <filter>input['input_select'] == "accession_number"</filter>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
103 <change_format>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
104 <when input="outputformat" value="sam" format="sam"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
105 </change_format>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
106 </data>
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
107 <data name="output_file" format="bam" label="${input.file.name} (sam-dump)">
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
108 <filter>input['input_select'] == "file"</filter>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
109 <change_format>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
110 <when input="outputformat" value="sam" format="sam"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
111 </change_format>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
112 </data>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
113 </outputs>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
114 <tests>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
115 <test>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
116 <param name="input_select" value="accession_number"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
117 <param name="accession" value="SRR925743"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
118 <param name="outputformat" value="sam"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
119 <param name="region" value="17:41243452-41277500"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
120 <output name="output_accession" file="sam_dump_result.sam" compare="contains" ftype="sam"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
121 </test>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
122 </tests>
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
123 <help><![CDATA[
10
73f1fbdea468 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
124
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
125 **What it does?**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
126
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
127 This tool extracts data (in BAM_ format) from the Short Read Archive (SRA) at the National Center for Biotechnology Information (NCBI). It is based on the sam-dump_ utility of the SRA Toolkit.
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
128
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
129 **How to use it?**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
130
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
131 There are three ways in which you can download data:
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
132
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
133 1. Data for single accession
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
134 2. Multiple datasets using a list of accessions
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
135 3. Extract data from already uploaded SRA dataset
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
136
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
137 Below we discuss each in detail.
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
138
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
139 ------
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
140
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
141 **Uploading data for a single accession**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
142
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
143 When you type a single accession number (e.g., `SRR1582967`) into **Accession** box and click **Execute** the tool will fetch data for you. As a result you will get a single BAM (or SAM) dataset in the history.
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
144
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
145 -----
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
146
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
147 **Uploading multiple datasets using a list of accessions**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
148
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
149 A more realistic scenario is when you want to upload a number of datasets at once. To do this you need a list of accession, where there is only one accession per line (see below for information on how to generate such a file). Once you have this file:
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
150
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
151 1. Upload it into your history using Galaxy's upload tool
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
152 2. Once the list of accessions is uploaded choose *List of SRA accessions, one per line* from **select input type** dropdown
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
153 3. Choose uploaded file within the **sra accession list** field
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
154 4. Click **Execute**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
155
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
156 .. class:: warningmark
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
157
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
158 BAM datasets produced by this option will be saved in Galaxy's history as a collection_ - a single history element containing multiple datasets.
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
159
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
160 -----
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
161
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
162 **Extract data from already uploaded SRA dataset**
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
163
14
5c5d6624f8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
164 If a SRA dataset is present in the history, it can be converted into BAM dataset by setting **select input type** drop-down to *SRA archive in current history*. Just like in the case of extracting data for single accession number a single BAM dataset will be generated in the history.
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
165
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
166 @ACCESSION_LIST_HOWTO@
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
167
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
168 -----
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
169
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
170 .. _BAM: https://samtools.github.io/hts-specs/SAMv1.pdf
22
fe99dc15b7af "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 21f935ba50d3e4b455246c681e54d5c57c67032f"
iuc
parents: 20
diff changeset
171 .. _sam-dump: https://trace.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=toolkit_doc&f=sam-dump
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
172 .. _collection: https://galaxyproject.org/tutorials/collections/
17
37f09413ddbf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 15
diff changeset
173 .. _link: https://trace.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=studies
7
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
174
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
175 @SRATOOLS_ATTRRIBUTION@
52a8ae1be0d5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
176 ]]></help>
0
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
177 <expand macro="citation"/>
20da3b075bbf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
178 </tool>