Mercurial > repos > iuc > umi_tools_count

annotate umi-tools_counts.xml @ 0:8db56d2f8b72 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
author iuc
date Thu, 21 Jun 2018 15:20:14 -0400
parents
children 3c932ad4a174
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
1 <tool id="umi_tools_count" name="UMI-tools count" version="@VERSION@.0">
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
2 <description>Count UMIs from BAM files</description>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
3 <macros>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
4 <import>macros.xml</import>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
5 <xml name="sanitize_tag" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
6 <sanitizer invalid_char="">
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
7 <valid initial="string.letters,string.digits" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
8 </sanitizer>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
9 </xml>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
10 </macros>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
11 <expand macro="requirements" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
13
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
14 ln -s '${input_bam}' 'input.bam' &&
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
15 ln -s '${input_bam.metadata.bam_index}' 'input.bam.bai' &&
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
16
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
17 umi_tools count
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
18 -I input.bam
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
19 '$bam_paired'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
20 --extract-umi-method='$barcodes.extract_umi_method.value'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
21 #if $barcodes.extract_umi_method == 'read_id':
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
22 --umi-separator='$barcodes.delimiter'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
23 #else if $barcodes.extract_umi_method == 'tag':
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
24 --umi-tag='$barcodes.umi_tag'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
25 --cell-tag='$barcodes.cell_tag'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
26 #end if
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
27 --method='$grouping_method.value'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
28 --edit-distance-threshold='$hamming_distance'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
29 --mapping-quality='$advanced.mapping_quality'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
30 --per-gene
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
31 $wide_format_cell_counts
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
32 $advanced.per_contig
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
33 '$advanced.per_cell'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
34 #if $advanced.gene_tag:
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
35 --gene-tag='$advanced.gene_tag'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
36 #end if
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
37 #if $advanced.skip_tags_regex.value:
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
38 --skip-tags-regex='$advanced.skip_tags_regex'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
39 #end if
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
40 #if $advanced.random_seed != 0:
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
41 --random-seed='$advanced.random_seed'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
42 #end if
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
43 -S '$out_counts'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
44 -L '$out_log'
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
45 ]]></command>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
46 <inputs>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
47 <param name="input_bam" type="data" format="bam" label="Sorted BAM file" help="Please use the samtools sort tool to ensure a correct BAM input" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
48
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
49 <param name="bam_paired" type="boolean" truevalue="--paired" falsevalue="" checked="false"
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
50 label="Bam is paired-end"
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
51 help="both read pairs will be output. This will also force the use of the template length to determine
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
52 reads with the same mapping coordinates." />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
53
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
54 <conditional name="barcodes" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
55 <param name="extract_umi_method" type="select" label="Umi Extract Method" help="How are the barcodes encoded in the read?" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
56 <option value="read_id" selected="true">Barcodes are contained at the end of the read seperated by a delimiter</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
57 <option value="tag" >Barcodes are contained in tags</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
58 <option value="umis" >Barcodes were extracted using umis</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
59 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
60 <when value="read_id" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
61 <param name="delimiter" type="text" label="Delimiter between read id and the UMI" value="_" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
62 <expand macro="sanitize_tag" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
63 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
64 </when>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
65 <when value="tag" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
66 <param name="umi_tag" type="text" label="Tag which contains the UMI" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
67 <expand macro="sanitize_tag" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
68 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
69 <param name="cell_tag" type="text" label="Tag which contains the cell barcode" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
70 <expand macro="sanitize_tag" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
71 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
72 </when>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
73 <when value="umis"></when>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
74 </conditional>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
75
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
76 <param name="grouping_method" type="select" label="Method to identify group of reads" help="UMIs with the same (or similar) codes can be grouped together. The simplest methods 'unique' and 'percentile' group identical
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
77 UMIs, however 'cluster', 'adjacency', and 'directional' can group similar umis with edit distances less than some threshold. Unique: Reads group share the exact same UMI. Percentile: Reads group share the same UMI, and UMIs with
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
78 counts &lt; 1% of the median counts for UMIs at the same position are ignored. Cluster: Identify clusters of connected UMIs (based on hamming distance threshold). Adjacency: Same as cluster, but considers only directly ajacent
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
79 UMIs in the cluster. Directional: Identify cluster of connected UMIs based on hamming distance and umi." >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
80 <option value="unique" >Unique</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
81 <option value="percentile">Percentile</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
82 <option value="cluster">Cluster</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
83 <option value="adjacency">Adjacency</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
84 <option value="directional" selected="true" >Directional</option>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
85 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
86
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
87 <param name="hamming_distance" type="integer" label="Edit distance threshold" min="0" value="1" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
88 <param name="wide_format_cell_counts" type="boolean" truevalue="--wide-format-cell-counts" falsevalue="" checked="false" label="Output a mtrix of genes and cells, instead of a flat file" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
89
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
90 <section name="advanced" title="Extra parameters" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
91 <param name="mapping_quality" type="integer" min="0" value="0" label="Minimum mapping quality" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
92 <!-- Currently hard-coded parameter. Leave here if useful to future wrapper -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
93 <!-- <param argument="-\-per-gene" name="per_gene" type="text" label="Group reads together if they have the same gene" help="Reads will be grouped together if they have the same gene. This is useful if your library
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
94 prep generates PCR duplicates with non-identical alignment positions such as CEL-Seq. Note this option is hardcoded to be on with the count command. I.e counting is always performed per-gene. Must be combined with either
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
95 -\-gene-tag or -\-per-contig option" /> -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
96 <param name="gene_tag" type="text" label="Deduplicate per gene." help="The gene information is encoded in the bam read tag." value="" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
97 <expand macro="sanitize_tag" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
98 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
99 <param name="skip_tags_regex" type="text" label="Skip any reads where the gene matches this tag" value="" >
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
100 <sanitizer invalid_char="">
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
101 <valid initial="string.letters,string.digits">
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
102 <add value="!="/>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
103 <add value="-"/>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
104 <add value="_"/>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
105 <add value="."/>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
106 <add value="?"/>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
107 <add value="&lt;"/><!-- left triangle bracket -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
108 <add value="&gt;"/><!-- right triangle bracket -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
109 <add value="&#91;"/> <!-- left square bracket -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
110 <add value="&#93;"/> <!-- right square bracket -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
111 <add value="&#94;"/> <!-- caret -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
112 <add value="&#123;"/> <!-- left curly -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
113 <add value="&#125;"/> <!-- right curly -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
114 <add value="&#40;"/> <!-- left parenthesis -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
115 <add value="&#41;"/> <!-- right parenthesis -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
116 </valid>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
117 </sanitizer>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
118 </param>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
119 <param name="per_contig" type="boolean" truevalue="--per-contig" falsevalue="" checked="false"
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
120 label="Deduplicate per contig (field 3 in BAM; RNAME)"
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
121 help="All reads with the same contig will be considered to have the same alignment position. This is useful if you have aligned to a reference transcriptome with one transcript per gene." />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
122 <param name="per_cell" type="boolean" truevalue="--per-cell" falsevalue="" checked="false"
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
123 label="Group reads only if they have the same cell barcode." />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
124 <param name="random_seed" type="integer" min="0" value="0" label="Random Seed" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
125 </section>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
126 </inputs>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
127 <outputs>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
128 <data name="out_counts" format="tsv" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
129 <data name="out_log" format="txt" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
130 </outputs>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
131 <tests>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
132 <test><!--count_single_gene_tag:-->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
133 <param name="input_bam" value="chr19_gene_tags.bam" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
134 <param name="random_seed" value="123456789" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
135 <param name="grouping_method" value="directional" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
136 <param name="gene_tag" value="XF" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
137 <param name="skip_tags_regex" value="^[__|Unassigned]" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
138 <param name="extract_umi_method" value="umis" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
139 <output name="out_counts" value="count_single_gene_tag.tsv" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
140 </test>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
141 <test><!--count_single_cells_gene_tag:-->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
142 <param name="input_bam" value="chr19_gene_tags.bam" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
143 <param name="random_seed" value="123456789" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
144 <param name="grouping_method" value="directional" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
145 <param name="gene_tag" value="XF" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
146 <param name="skip_tags_regex" value="^[__|Unassigned]" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
147 <param name="per_cell" value="true" /><!-- new -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
148 <param name="extract_umi_method" value="umis" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
149 <output name="out_counts" value="count_single_cells_gene_tag.tsv" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
150 </test>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
151 <test><!--count_single_cells_wide_gene_tag:-->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
152 <param name="input_bam" value="chr19_gene_tags.bam" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
153 <param name="random_seed" value="123456789" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
154 <param name="grouping_method" value="directional" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
155 <param name="gene_tag" value="XF" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
156 <param name="skip_tags_regex" value="^[__|Unassigned]" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
157 <param name="per_cell" value="true" /><!-- new -->
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
158 <param name="extract_umi_method" value="umis" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
159 <param name="wide_format_cell_counts" value="true" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
160 <output name="out_counts" value="count_single_cells_gene_tag_wide.tsv" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
161 </test>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
162 </tests>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
163 <help><![CDATA[
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
164
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
165 UMI Tools count - Count reads per gene from BAM using UMIs
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
166 ----------------------------------------------------------
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
167
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
168 Purpose
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
169 -------
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
170
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
171 The purpose of this command is to count the number of reads per gene based
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
172 on the mapping co-ordinate and the UMI attached to the read.
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
173
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
174
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
175 It is assumed that the FASTQ files were processed with extract_umi.py
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
176 before mapping and thus the UMI is the last word of the read name. e.g:
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
177
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
178 @HISEQ:87:00000000_AATT
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
179
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
180 where AATT is the UMI sequeuence.
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
181
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
182 If you have used an alternative method which does not separate the
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
183 read id and UMI with a "_", such as bcl2fastq which uses ":", you can
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
184 specify the separator, or if your UMIs are encoded in a tag you can also specify this.
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
185
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
186 ]]></help>
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
187 <expand macro="citations" />
8db56d2f8b72 planemo upload commit c79a5f4a05156bb2a6035a844aa9ad8f0e59ecb5
iuc
parents:
diff changeset
188 </tool>