annotate sam_dump.xml @ 22:751a694ec620 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 1db2b3ee758847b8b63f58fb2075961003ff8c22"
author iuc
date Mon, 20 Jul 2020 07:27:41 -0400
parents 494b2ec08162
children 653e89d73fc4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
751a694ec620 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 1db2b3ee758847b8b63f58fb2075961003ff8c22"
iuc
parents: 21
diff changeset
1 <tool id="sam_dump" name="Download and Extract Reads in BAM" version="@VERSION@+galaxy2" profile="18.01">
7
c7620aa7e1f0 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>
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
3 <macros>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
4 <import>sra_macros.xml</import>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
5 </macros>
16
aad3885b3216 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
6 <expand macro="requirements">
aad3885b3216 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
7 <requirement type="package" version="1.10">samtools</requirement>
aad3885b3216 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
8 </expand>
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
9 <version_command>sam-dump --version</version_command>
4
62e4d56ebb6f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4091428e9e28ca06263bc00cdf938d20f620aa4d
iuc
parents: 3
diff changeset
10 <command detect_errors="exit_code">
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
11 <![CDATA[
18
7068f48d0ef9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 16
diff changeset
12 @COPY_CONFIGFILE@
13
c38286ea7047 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 686710a7d313b828f1daed20c4055479727f2d91
iuc
parents: 10
diff changeset
13 @SET_ACCESSIONS@
1
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
14
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
15 ## Do not use prefetch if region is specified, to avoid downloading
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
16 ## the complete sra file.
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
17
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
18 #if $input.input_select == "file":
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
19 sam-dump --log-level fatal '${input.file.name}'
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
20 #else:
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
21 #if ( str( $adv.region ) == "" ):
16
aad3885b3216 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 2be63abd7e4db27fa32ecbbc10d48cacb0073115"
iuc
parents: 14
diff changeset
22 prefetch -X 200000000 "\$acc" &&
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
23 #end if
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
24 sam-dump --log-level fatal --disable-multithreading
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
25 #end if
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
26
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
27 #if str( $adv.region ) != "":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
28 --aligned-region '$adv.region'
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
29 #end if
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
30 #if str( $adv.matepairDist ) != "":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
31 --matepair-distance '$adv.matepairDist'
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
32 #end if
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
33 #if str( $adv.minMapq ) != "":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
34 --min-mapq '$adv.minMapq'
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
35 #end if
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
36 --header
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
37 #if str( $adv.alignments ) == "both":
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
38 --unaligned
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
39 #end if
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
40
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
41 #if str( $adv.alignments ) == "unaligned":
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
42 --unaligned-spots-only
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
43 #end if
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
44 #if (str( $adv.primary ) == "yes") and (str ( $adv.alignments != "unaligned") ):
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
45 --primary
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
46 #end if
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
47 #if $input.input_select == "file":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
48 '$input.file'
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
49 #elif $input.input_select == "accession_number":
1
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
50 "\$acc"
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
51 #elif $input.input_select=="file_list":
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
52 "\$acc"
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
53 #end if
2
f256cb398262 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4e83a7f6d542cd3129eb14a142f74c127f91d026
iuc
parents: 1
diff changeset
54
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
55 #if str( $outputformat ) == "bam":
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
56 | samtools view -Sb - 2> /dev/null
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
57 #end if
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
58 #if $input.input_select == "file":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
59 > '$output_file'
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
60 #elif $input.input_select == "accession_number":
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
61 > '$output_accession' )
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
62 #end if
1
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
63
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
64 #if $input.input_select=="file_list":
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
65 #if str( $outputformat ) == "bam":
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
66 > "\$acc.bam"
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
67 #elif str( $outputformat ) == "sam":
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
68 > "\$acc.sam"
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
69 #end if
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
70 ) ; done
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
71 #end if
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
72
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
73 ]]>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
74 </command>
18
7068f48d0ef9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 16
diff changeset
75 <expand macro="configfile_hack"/>
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
76 <inputs>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
77 <expand macro="input_conditional"/>
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
78 <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
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
79 <option value="bam">bam</option>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
80 <option value="sam">sam</option>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
81 </param>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
82 <section name="adv" title="Advanced Options" expanded="False">
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
83 <expand macro="alignments"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
84 <expand macro="region"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
85 <expand macro="matepairDist"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
86 <param name="primary" type="select" value="no">
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
87 <label>only primary aligments</label>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
88 <option value="no">No</option>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
89 <option value="yes">Yes</option>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
90 </param>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
91 <expand macro="minMapq"></expand>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
92 </section>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
93 </inputs>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
94 <outputs>
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
95 <collection name="output_collection" type="list" label="SAM/BAM data (fastq-dump)">
1
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
96 <filter>input['input_select'] == "file_list"</filter>
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
97 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.bam" directory="." ext='bam'/>
462ee06c9358 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4defaa3ff1c21e2ec39033bfe63ee69471104ede
iuc
parents: 0
diff changeset
98 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.sam" directory="." ext='sam'/>
2
f256cb398262 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 4e83a7f6d542cd3129eb14a142f74c127f91d026
iuc
parents: 1
diff changeset
99 </collection>
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
100 <data name="output_accession" format="bam" label="${input.accession} (sam-dump)">
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
101 <filter>input['input_select'] == "accession_number"</filter>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
102 <change_format>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
103 <when input="outputformat" value="sam" format="sam"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
104 </change_format>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
105 </data>
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
106 <data name="output_file" format="bam" label="${input.file.name} (sam-dump)">
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
107 <filter>input['input_select'] == "file"</filter>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
108 <change_format>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
109 <when input="outputformat" value="sam" format="sam"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
110 </change_format>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
111 </data>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
112 </outputs>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
113 <tests>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
114 <test>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
115 <param name="input_select" value="accession_number"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
116 <param name="accession" value="SRR925743"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
117 <param name="outputformat" value="sam"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
118 <param name="region" value="17:41243452-41277500"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
119 <output name="output_accession" file="sam_dump_result.sam" compare="contains" ftype="sam"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
120 </test>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
121 </tests>
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
122 <help><![CDATA[
10
8c00bc7fd8de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 48c9d7f30655d48c9b46b9ca7a17c454eb54694d
iuc
parents: 9
diff changeset
123
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
124 **What it does?**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
125
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
126 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.
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
127
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
128 **How to use it?**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
129
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
130 There are three ways in which you can download data:
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
131
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
132 1. Data for single accession
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
133 2. Multiple datasets using a list of accessions
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
134 3. Extract data from already uploaded SRA dataset
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
135
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
136 Below we discuss each in detail.
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
137
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
138 ------
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
139
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
140 **Uploading data for a single accession**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
141
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
142 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
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
143
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
144 -----
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
145
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
146 **Uploading multiple datasets using a list of accessions**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
147
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
148 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:
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
149
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
150 1. Upload it into your history using Galaxy's upload tool
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
151 2. Once the list of accessions is uploaded choose *List of SRA accessions, one per line* from **select input type** dropdown
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
152 3. Choose uploaded file within the **sra accession list** field
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
153 4. Click **Execute**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
154
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
155 .. class:: warningmark
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
156
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
157 BAM datasets produced by this option will be saved in Galaxy's history as a collection_ - a single history element containing multiple datasets.
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
158
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
159 -----
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
160
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
161 **Extract data from already uploaded SRA dataset**
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
162
14
1790dcf3c32d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit 30ec06de1f3056967f5cc2d8ef57f9692d5533d7
iuc
parents: 13
diff changeset
163 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
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
164
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
165 @ACCESSION_LIST_HOWTO@
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
166
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
167 -----
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
168
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
169 .. _BAM: https://samtools.github.io/hts-specs/SAMv1.pdf
18
7068f48d0ef9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 16
diff changeset
170 .. _sam-dump: https://ncbi.github.io/sra-tools/sam-dump.html
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
171 .. _collection: https://galaxyproject.org/tutorials/collections/
18
7068f48d0ef9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d22c001db39b52ebaa54837bebe2765c17b5c876"
iuc
parents: 16
diff changeset
172 .. _link: https://trace.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=studies
7
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
173
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
174 @SRATOOLS_ATTRRIBUTION@
c7620aa7e1f0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d1347141d384ed404f674d7ce408b6769e763ea1
iuc
parents: 4
diff changeset
175 ]]></help>
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
176 <expand macro="citation"/>
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
177 </tool>