annotate samtools_depth.xml @ 3:ad06afad0c44 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 5cb103832529f17e5c72e7f122758c13519fbe5e
author iuc
date Mon, 15 Aug 2022 09:08:32 +0000
parents 6bb273ed8785
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
ad06afad0c44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 5cb103832529f17e5c72e7f122758c13519fbe5e
iuc
parents: 2
diff changeset
1 <tool id="samtools_depth" name="Samtools depth" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
2 <description>compute the depth at each position or region</description>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
3 <macros>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
4 <import>macros.xml</import>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
5 </macros>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
7 <expand macro="stdio"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
9 <command><![CDATA[
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
10 ## create symlinks to bams and index files (0,..., n-1 + 0.[bai|crai],...,n-1.[bai|crai] )
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
11 @PREPARE_IDX_MULTIPLE@
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
12
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
13 samtools depth
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
14 $all
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
15 #if $cond_region.select_region == 'bed':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
16 -b '$cond_region.input_bed'
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
17 #else if $cond_region.select_region == 'text':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
18 -r $cond_region.region
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
19 #end if
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
20 #if str($minlength) != '':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
21 -l $minlength
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
22 #end if
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
23 #if str($maxdepth) != '':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
24 -m $maxdepth
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
25 #end if
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
26 #if str($basequality) != '':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
27 -q $basequality
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
28 #end if
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
29 #if str($mapquality) != '':
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
30 -Q $mapquality
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
31 #end if
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
32 #for $i in range(len( $input_bams )):
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
33 ${i}
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
34 #end for
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
35 #set $filter = $additional_options.required_flags
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
36 @FLAGS@
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
37 -g $flags
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
38 #set $filter = $additional_options.skipped_flags
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
39 @FLAGS@
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
40 -G $flags
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
41 $additional_options.deletions
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
42 $additional_options.single_read
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
43 $output_options.header
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
44 > '${output}'
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
45 ]]></command>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
46 <inputs>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
47 <param name="input_bams" type="data" format="bam" multiple="true" label="BAM file(s)" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
48 <conditional name="cond_region">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
49 <param name="select_region" type="select" label="Filter by regions">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
50 <option value="no" selected="True">No</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
51 <option value="text">Manualy specify a region</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
52 <option value="bed">Regions from BED file</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
53 </param>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
54 <when value="no"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
55 <when value="text">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
56 <param name="region" type="text" optional="false" argument="-r" label="Only report depth in a specified region" help="Format is CHROMOSOME:FROM-TO"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
57 </when>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
58 <when value="bed">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
59 <param name="input_bed" type="data" format="bed" argument="-b" label="Genomic intervals (in BED format)" help="Compute depth at list of positions or regions in specified BED FILE." />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
60 </when>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
61 </conditional>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
62
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
63 <param name="all" type="select" argument="-a/-aa" label="Output all positions" help="Note that if the all option (-a) is used in conjunction with a BED file it may sometimes operate as if -aa was specified if the reference sequence has coverage outside of the region specified in the BED file.">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
64 <option value="" selected="True">Default</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
65 <option value="-a">Output all positions (including those with zero depth) (-a)</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
66 <option value="-aa">Output absolutely all positions, including unused reference sequences. (-aa)</option>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
67 </param>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
68 <param name="minlength" type="integer" argument="-l" min="0" optional="true" label="Ignore reads shorter than" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
69 <param name="maxdepth" type="integer" argument="-m" min="0" optional="true" label="Limits the maximum number of considered alignments starting at any sequence position to INT. Note that, the reported depths values might be larger than INT. If 0, depth is set to the maximum integer value, effectively removing any depth limit. (default = 8000)" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
70
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
71 <param name="basequality" type="integer" argument="-q" min="0" optional="true" label="Only count reads with base quality greater than" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
72 <param name="mapquality" type="integer" argument="-Q" min="0" optional="true" label="Only count reads with mapping quality greater than" />
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
73
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
74 <section name="additional_options" title="Additional Filter Options">
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
75 <param name="required_flags" argument="-g" type="select" multiple="True" label="Require that these flags are set.">
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
76 <expand macro="flag_options" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
77 </param>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
78
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
79 <param name="skipped_flags" argument="-G" type="select" multiple="True" label="Exclude reads with any of the following flags set (the default set is UNMAP,SECONDARY,QCFAIL,DUP or 0x704).">
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
80 <expand macro="flag_options" s4="true" s256="true" s512="true" s1024="true"/>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
81 </param>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
82
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
83 <param name="deletions" type="boolean" argument="-J" truevalue="-J" falsevalue="" checked="false" label="Include reads with deletions in depth computation." />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
84 <param name="single_read" type="boolean" argument="-s" truevalue="-s" falsevalue="" checked="false" label="For the overlapping section of a read pair, count only the bases of a single read." />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
85 </section>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
86
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
87 <section name="output_options" title="Output Options" expanded="true">
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
88 <param name="header" type="boolean" argument="-H" truevalue="-H" falsevalue="" checked="false" label="Print a file header to file." />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
89 </section>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
90
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
91 </inputs>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
92 <outputs>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
93 <data name="output" format="tabular" label="${tool.name} on ${on_string}" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
94 </outputs>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
95 <tests>
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
96 <!-- 1) -->
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
97 <test>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
98 <conditional name="cond_region">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
99 <param name="select_region" value="bed"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
100 <param name="input_bed" value="eboVir3.1.bed" ftype="bed" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
101 </conditional>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
102 <param name="input_bams" value="eboVir3.bam" ftype="bam" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
103 <output name="output" file="samtools_depth_out1.tab" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
104 </test>
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
105 <!-- 2) -->
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
106 <test>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
107 <conditional name="cond_region">
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
108 <param name="select_region" value="text"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
109 <param name="region" value="eboVir3:500-1500" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
110 </conditional>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
111 <param name="input_bams" value="eboVir3.bam" ftype="bam" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
112 <output name="output" file="samtools_depth_out2.tab" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
113 </test>
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
114 <!-- 3) -->
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
115 <test>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
116 <param name="input_bams" value="eboVir3.bam,eboVir3.2.bam" ftype="bam" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
117 <param name="all" value="-a"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
118 <output name="output" file="samtools_depth_out3.tab" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
119 </test>
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
120 <!-- 4) -->
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
121 <test>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
122 <param name="input_bams" value="eboVir3.bam,eboVir3.2.bam" ftype="bam" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
123 <param name="minlength" value="10" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
124 <!-- Odd thing: I did not expect values > 4 in the output, but there are ... ?
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
125 see https://github.com/samtools/samtools/issues/889 -->
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
126 <param name="maxdepth" value="4" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
127 <param name="basequality" value="11" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
128 <param name="mapquality" value="12" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
129 <output name="output" file="samtools_depth_out4.tab" />
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
130 </test>
2
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
131 <!-- 5) Testing argument -H -->
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
132 <test>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
133 <conditional name="cond_region">
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
134 <param name="select_region" value="bed"/>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
135 <param name="input_bed" value="eboVir3.1.bed" ftype="bed" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
136 </conditional>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
137 <param name="input_bams" value="eboVir3.bam" ftype="bam" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
138 <param name="header" value="true" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
139 <output name="output" file="samtools_depth_out5.tab" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
140 </test>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
141 <!-- 6) Tetsing argument -g -->
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
142 <test>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
143 <param name="input_bams" value="eboVir3.bam" ftype="bam" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
144 <param name="required_flags" value="2,16,64" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
145 <output name="output" file="samtools_depth_out6.tab" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
146 </test>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
147 <!-- 7) Tetsing argument -G -->
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
148 <test>
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
149 <param name="input_bams" value="eboVir3.bam" ftype="bam" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
150 <param name="skipped_flags" value="2,16,64" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
151 <output name="output" file="samtools_depth_out7.tab" />
6bb273ed8785 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 1
diff changeset
152 </test>
0
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
153 </tests>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
154 <help>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
155 **What it does**
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
156
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
157 Computes the depth at each position or region using the ``samtools depth`` command.
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
158
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
159 The output is a tabular file, with one line for each base of each reference
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
160 with any coverage (bases with no coverage may not appear).
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
161
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
162 The first column is the reference name, the second column is the reference
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
163 position, and then there is one column for each SAM/BAM file giving the
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
164 coverage depth at that position.
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
165 </help>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
166 <expand macro="citations"/>
11649ca077f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_depth commit b75040a9832972a60a964bc5a35da029d2bcf86c
iuc
parents:
diff changeset
167 </tool>