Mercurial > repos > iuc > samtools_merge

annotate samtools_merge.xml @ 0:ce3f4ecc9258 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
author iuc
date Fri, 28 Sep 2018 04:24:35 -0400
parents
children a27cd1e0d9a5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
1 <tool id="samtools_merge" name="Samtools merge" version="@TOOL_VERSION@">
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
2 <description>merge multiple sorted alignment files</description>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
3 <macros>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
4 <import>macros.xml</import>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
5 </macros>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
7 <expand macro="stdio"/>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
9 <command><![CDATA[
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
10 @ADDTHREADS@
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
11
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
12 ## prepare input (sort sam, link other), determine input ordering
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
13 ## and check for consistent input ordering
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
14 #set sortby=''
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
15 #for $i, $bam in enumerate( $bamfiles ):
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
16 #if $bam.is_of_type('sam', 'cram', ):
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
17 samtools sort
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
18 -@ \$addthreads -m \${GALAXY_MEMORY_MB:-768}M -T sorttemp
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
19 -O sam
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
20 -o ${i}.sam
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
21 '$bam' &&
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
22 #else:
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
23 ln -s '$bam' ${i}.sam &&
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
24 #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
25
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
26 #if ($sortby=='coord' or $sortby=='') and $bam.is_of_type('sam','bam','cram'):
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
27 #set sortby='coord'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
28 #else if ($sortby=='name' or $sortby=='') and $bam.is_of_type('qname_sorted.bam', 'qname_input_sorted.bam'):
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
29 #set $sortby='name'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
30 #else:
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
31 >&2 echo "inconsistently sorted input" &&
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
32 exit 1 &&
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
33 #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
34 #end for
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
35
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
36 samtools merge
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
37 -@ \$addthreads
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
38 -s $seed
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
39 ## TODO force overwrite seems necessay (but I do not understand why ...)
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
40 -f
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
41 ## Galaxy provides only default compression
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
42 ## #if $compression == 'levelone'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
43 ## -1
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
44 ## #else if $compression == 'uncompressed'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
45 ## -u
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
46 ## #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
47 #if str($headerbam) != 'None'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
48 -h '$headerbam'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
49 #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
50 #if $sortby=='name'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
51 -n
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
52 #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
53 ## TODO since galaxy can't represent this as data type at the moment this option is unsupported
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
54 ## -t TAG The input alignments have been sorted by the value of TAG, then by either position or name (if -n is given).
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
55 #if str($region) != ''
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
56 -R '$region'
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
57 #end if
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
58 ## Attach an RG tag to each alignment. The tag value is inferred from file names.
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
59 ## -r
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
60 ## TODO -r makes no sense with the link names, is there some data set metadata (tags,...) that could be used?
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
61 $idrg
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
62 $idpg
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
63 $output
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
64 #for $i, $bam in enumerate( $bamfiles ):
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
65 ${i}.sam
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
66 #end for
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
67 ]]></command>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
68 <inputs>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
69 <param name="bamfiles" type="data" format="sam,bam,cram" multiple="true" optional="false" label="Alignments in BAM format" help="Sets of aligned reads." />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
70 <param name="region" type="text" optional="true" argument="-n" label="Merge files in a region" help="Merge files in the specified region indicated by a string" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
71 <param name="headerbam" type="data" format="sam,bam" argument="-h" multiple="false" optional="true" label="File to take @headers from" help="Use the lines of FILE as `@' headers to be copied to out.bam, replacing any header lines that would otherwise be copied from in1.bam. (FILE is actually in SAM format, though any alignment records it may contain are ignored.)" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
72 <param name="idrg" type="boolean" argument="-c" truevalue="-c" falsevalue="" checked="false" label="Make @RG headers unique" help="When several input files contain @RG headers with the same ID, emit only one of them (namely, the header line from the first file we find that ID in) to the merged output file. Combining these similar headers is usually the right thing to do when the files being merged originated from the same file. Without -c, all @RG headers appear in the output file, with random suffices added to their IDs where necessary to differentiate them." />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
73 <param name="idpg" type="boolean" argument="-p" truevalue="-p" falsevalue="" checked="false" label="Make @PG headers unique" help="Similarly, for each @PG ID in the set of files to merge, use the @PG line of the first file we find that ID in rather than adding a suffix to differentiate similar IDs." />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
74 <param name="seed" type="integer" argument="-s" value="1" label="random seed" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
75 <!-- compression options are not accessible in galaxy
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
76 <param name="compression" type="select" label="Advanced compression options" help="Select advanced compression options">
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
77 <option value="default" selected="true">default</option>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
78 <option value="levelone">Use zlib compression level 1</option>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
79 <option value="uncompressed">Uncompressed output</option>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
80 </param>-->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
81 </inputs>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
82 <outputs>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
83 <data name="output" format="bam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
84 </outputs>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
85 <tests>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
86 <!-- tests and data extracted from
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
87 https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
88 https://github.com/samtools/samtools/tree/develop/test/merge -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
89 <!-- # Merge 1 - Standard 3 file SAM merge all presented on the command line (only checks for similar size, because generated header info differs) -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
90 <test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
91 <param name="bamfiles" value="test_input_1_a.sam,test_input_1_b.sam,test_input_1_c.sam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
92 <output name="output" file="2.merge.expected.bam" compare="sim_size" delta="50" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
93 </test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
94 <!-- Merge 2 - Standard 3 file BAM merge all files presented on the command line -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
95 <test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
96 <param name="bamfiles" value="test_input_1_a.bam,test_input_1_b.bam,test_input_1_c.bam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
97 <output name="output" file="2.merge.expected.bam" compare="sim_size" delta="50" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
98 </test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
99 <!-- Merge 4 - 1 file BAM merge with file presented on the command line -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
100 <test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
101 <param name="bamfiles" value="test_input_1_b.bam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
102 <output name="output" file="4.merge.expected.bam" compare="sim_size" delta="50" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
103 </test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
104 <!--Merge 5 - 3 file SAM merge all presented on the command line override IDs to file names (not implemented in tool) -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
105 <!--Merge 6 - merge all presented on the command line, combine PG and RG rather than dedup -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
106 <test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
107 <param name="bamfiles" value="test_input_1_a.bam,test_input_1_b.bam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
108 <param name="idrg" value="-c" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
109 <param name="idpg" value="-p" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
110 <output name="output" file="6.merge.expected.bam" compare="sim_size" delta="50" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
111 </test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
112 <!-- Merge 7 - ID and SN with regex in them (probably not necessary for the galaxy tool because just different input) -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
113 <test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
114 <param name="bamfiles" value="test_input_1_a_regex.sam,test_input_1_b_regex.sam" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
115 <output name="output" file="7.merge.expected.bam" compare="sim_size" delta="50" />
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
116 </test>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
117 <!-- Sort inputs by PG, then merge (not implemented, since -t not supported in the tool) -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
118 <!-- Sort inputs by PG, then merge (name sorted) (not implemented, since -t not supported in the tool) -->
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
119 </tests>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
120 <help>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
121 **What it does**
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
122 Merge multiple sorted alignment files, producing a single sorted output file that contains all the input records and maintains the existing sort order.
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
123
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
124 If a file to take @headers from is specified the @SQ headers of input files will be merged into the specified header, otherwise they will be merged into a composite header created from the input headers. If in the process of merging @SQ lines for coordinate sorted input files, a conflict arises as to the order (for example input1.bam has @SQ for a,b,c and input2.bam has b,a,c) then the resulting output file will need to be re-sorted back into coordinate order.
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
125
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
126 Unless the @PG/@RG headers are made unique when merging @RG and @PG records into the output header then any IDs found to be duplicates of existing IDs in the output header will have a suffix appended to them to differentiate them from similar header records from other files and the read records will be updated to reflect this.
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
127 </help>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
128 <expand macro="citations"/>
ce3f4ecc9258 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_merge commit 322cbb9a3bb01f858068bda319e72b0a3ff4251b
iuc
parents:
diff changeset
129 </tool>