Mercurial > repos > lparsons > htseq_count
annotate htseq-count.xml @ 11:f320093f1e8e
Removed sorting notice from help
| author | lparsons |
|---|---|
| date | Mon, 10 Dec 2012 13:36:54 -0500 |
| parents | 5d969cb56112 |
| children | 62a1de8c8aae |
| rev | line source |
|---|---|
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
1 <tool id="htseq_count" name="htseq-count" version="0.3"> |
| 0 | 2 <description> - Count aligned reads in a BAM file that overlap features in a GFF file</description> |
| 3 <version_command>htseq-count -h | grep version | sed 's/^\(.*\)*\(version .*\)\./\2/'</version_command> | |
| 4 <requirements> | |
|
4
14bec14f4290
Added tool_dependencies.xml back, dependency installation requires Galaxy changeset 7621:108cda898646
Lance Parsons <lparsons@princeton.edu>
parents:
3
diff
changeset
|
5 <requirement type="package" version="1.6.2">numpy</requirement> |
| 0 | 6 <requirement type="package" version="0.5.3p9">htseq</requirement> |
| 7 <requirement type="package" version="0.1.18">samtools</requirement> | |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
8 <requirement type="package" version="1.56.0">picard</requirement> |
| 0 | 9 </requirements> |
| 10 <command> | |
| 11 ##set up input files | |
| 12 #set $reference_fasta_filename = "localref.fa" | |
| 13 #if $samout_conditional.samout: | |
| 14 #if str( $samout_conditional.reference_source.reference_source_selector ) == "history": | |
| 15 ln -s "${samout_conditional.reference_source.ref_file}" "${reference_fasta_filename}" && | |
| 16 samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for htseq-count" >&2 && | |
| 17 #else: | |
| 18 #set $reference_fasta_filename = str( $samout_conditional.reference_source.ref_file.fields.path ) | |
| 19 #end if | |
| 20 #end if | |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
21 #if str($singlepaired) == "paired": |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
22 ln -s $samfile local_input.sam && |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
23 java -Xmx2G -jar "\$JAVA_JAR_PATH/SortSam.jar" VALIDATION_STRINGENCY=LENIENT SORT_ORDER=queryname O=prepared_input.sam I=local_input.sam TMP_DIR="${__new_file_path__}" |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
24 || echo "Error running Picard MergeSamFiles" >&2 && |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
25 #else: |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
26 #if $samfile.extension == "bam": |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
27 samtools view $samfile | |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
28 #else |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
29 ln -s $samfile prepared_input.sam && |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
30 #end if |
| 0 | 31 #end if |
| 32 htseq-count | |
| 33 --mode=$mode | |
| 34 --stranded=$stranded | |
| 35 --minaqual=$minaqual | |
| 8 | 36 --type=$featuretype |
| 0 | 37 --idattr=$idattr |
| 38 #if $samout_conditional.samout: | |
| 39 --samout=$__new_file_path__/${samoutfile.id}_tmp | |
| 40 #end if | |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
41 #if str($singlepaired) == "paired": |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
42 prepared_input.sam |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
43 #else: |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
44 #if $samfile.extension == "bam": |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
45 - |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
46 #else: |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
47 prepared_input.sam |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
48 #end if |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
49 #end if |
| 0 | 50 $gfffile |
|
3
f7a5b54a8d4f
Split feature and non-feature counts, removed tool_dependencies.xml (for now)
Lance Parsons <lparsons@princeton.edu>
parents:
0
diff
changeset
|
51 | awk '{if ($1 ~ "no_feature|ambiguous|too_low_aQual|not_aligned|alignment_not_unique") print $0 | "cat 1>&2"; else print $0}' > $counts 2>$othercounts |
| 0 | 52 #if $samout_conditional.samout: |
| 53 && samtools view -Su -t ${reference_fasta_filename}.fai $__new_file_path__/${samoutfile.id}_tmp | samtools sort -o - sorted > $samoutfile | |
| 54 #end if</command> | |
| 55 <inputs> | |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
56 <param format="sam, bam" name="samfile" type="data" label="Aligned SAM/BAM File"/> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
57 <param name="singlepaired" type="select" label="Is this library mate-paired?"> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
58 <help>Paired libraries will be sorted by read name prior to counting.</help> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
59 <option value="single" selected="true">single-end</option> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
60 <option value="paired">paired-end</option> |
| 0 | 61 </param> |
| 62 <param format="gff" name="gfffile" type="data" label="GFF File"/> | |
| 63 <param name="mode" type="select" label="Mode"> | |
| 64 <help>Mode to handle reads overlapping more than one feature.</help> | |
| 65 <option value="union" selected="true">Union</option> | |
| 66 <option value="intersection-strict">Intersection (strict)</option> | |
| 67 <option value="intersection-nonempty">Intersection (nonempty)</option> | |
| 68 </param> | |
| 69 <param name="stranded" type="select" label="Stranded"> | |
| 70 <help>Specify whether the data is from a strand-specific assay. 'Reverse' means yes with reversed strand interpretation.</help> | |
| 71 <option value="yes" selected="true">Yes</option> | |
| 72 <option value="no">No</option> | |
| 73 <option value="reverse">Reverse</option> | |
| 74 </param> | |
| 75 <param name="minaqual" type="integer" value="0" label="Minimum alignment quality"> | |
| 76 <help>Skip all reads with alignment quality lower than the given minimum value</help> | |
| 77 </param> | |
| 8 | 78 <param name="featuretype" type="text" value="exon" label="Feature type"> |
| 0 | 79 <help>Feature type (3rd column in GFF file) to be used. All features of other types are ignored. The default, suitable for RNA-Seq and Ensembl GTF files, is exon.</help> |
| 80 </param> | |
| 81 <param name="idattr" type="text" value="gene_id" label="ID Attribute"> | |
|
5
8a5d43b21c6e
Improved error handling
Lance Parsons <lparsons@princeton.edu>
parents:
4
diff
changeset
|
82 <help>GFF attribute to be used as feature ID. Several GFF lines with the same feature ID will be considered as parts of the same feature. The feature ID is used to identity the counts in the output table. All features of the specified type MUST have a value for this attribute. The default, suitable for RNA-SEq and Ensembl GTF files, is gene_id.</help> |
| 0 | 83 </param> |
| 84 <conditional name="samout_conditional"> | |
| 85 <param name="samout" type="boolean" value="False" truevalue="True" falsevalue="False" label="Additional BAM Output"> | |
| 86 <help>Write out all SAM alignment records into an output BAM file, annotating each line with its assignment to a feature or a special counter (as an optional field with tag ‘XF’).</help> | |
| 87 </param> | |
| 88 <when value="True"> | |
| 89 <conditional name="reference_source"> | |
| 90 <param name="reference_source_selector" type="select" label="Choose the source for the reference list"> | |
| 91 <option value="cached">Locally cached</option> | |
| 92 <option value="history">History</option> | |
| 93 </param> | |
| 94 <when value="cached"> | |
| 95 <param name="ref_file" type="select" label="Using reference genome"> | |
| 96 <options from_data_table="sam_fa_indexes"> | |
|
9
971e20519fb8
Fix for dbkey column check when output additional bam is selected
lparsons
parents:
8
diff
changeset
|
97 <filter type="data_meta" key="dbkey" ref="samfile" column="1"/> |
| 0 | 98 </options> |
| 99 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> | |
| 100 </param> | |
| 101 </when> | |
| 102 <when value="history"> <!-- FIX ME!!!! --> | |
| 103 <param name="ref_file" type="data" format="fasta" label="Using reference file" /> | |
| 104 </when> | |
| 105 </conditional> | |
| 106 </when> | |
| 107 </conditional> | |
| 108 </inputs> | |
| 109 | |
| 110 <outputs> | |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
111 <data format="tabular" name="counts" metadata_source="samfile" label="${tool.name} on ${on_string}"/> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
112 <data format="tabular" name="othercounts" metadata_source="samfile" label="${tool.name} on ${on_string} (no feature)"/> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
113 <data format="bam" name="samoutfile" metadata_source="samfile" label="${tool.name} on ${on_string} (BAM)"> |
| 0 | 114 <filter>samout_conditional['samout']</filter> |
| 115 </data> | |
| 116 </outputs> | |
| 117 | |
| 118 <stdio> | |
| 119 <exit_code range="1:" level="fatal" description="Unknown error occurred" /> | |
|
5
8a5d43b21c6e
Improved error handling
Lance Parsons <lparsons@princeton.edu>
parents:
4
diff
changeset
|
120 <regex match="htseq-count: command not found" source="stderr" level="fatal" description="The HTSeq python package is not properly installed, contact Galaxy administrators" /> |
|
8a5d43b21c6e
Improved error handling
Lance Parsons <lparsons@princeton.edu>
parents:
4
diff
changeset
|
121 <regex match="samtools: command not found" source="stderr" level="fatal" description="The samtools package is not properly installed, contact Galaxy administrators" /> |
|
8a5d43b21c6e
Improved error handling
Lance Parsons <lparsons@princeton.edu>
parents:
4
diff
changeset
|
122 <regex match="Error: Feature (.+) does not contain a '(.+)' attribute" source="both" level="fatal" description="Error parsing the GFF file, at least one feature of the specified 'Feature type' does not have a value for the specified 'ID Attribute'" /> |
|
8a5d43b21c6e
Improved error handling
Lance Parsons <lparsons@princeton.edu>
parents:
4
diff
changeset
|
123 <regex match="Error occured in line (\d+) of file" source="stderr" level="fatal" description="Unknown error parsing the GFF file" /> |
| 8 | 124 <regex match="Error" source="stderr" level="fatal" description="Unknown error occured" /> |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
125 <regex match="Warning: Read (.+) claims to have an aligned mate which could not be found. \(Is the SAM file properly sorted\?\)" source="stderr" level="warning" description="PAIRED DATA MISSING OR NOT PROPERLY SORTED. Try reruning and selecting the paired-end option. See stderr output of this dataset for more information." /> |
| 0 | 126 </stdio> |
| 127 | |
| 128 <tests> | |
| 129 <test> | |
| 130 <param name="samfile" value="htseq-test.sam" /> | |
| 131 <param name="gfffile" value="htseq-test.gff" /> | |
| 132 <param name="samout" value="False" /> | |
| 133 <output name="counts" file="htseq-test_counts.tsv" /> | |
|
3
f7a5b54a8d4f
Split feature and non-feature counts, removed tool_dependencies.xml (for now)
Lance Parsons <lparsons@princeton.edu>
parents:
0
diff
changeset
|
134 <output name="othercounts" file="htseq-test_othercounts.tsv" /> |
| 0 | 135 </test> |
| 136 <test> | |
| 137 <param name="samfile" value="htseq-test.bam" /> | |
| 138 <param name="gfffile" value="htseq-test.gff" /> | |
| 139 <param name="samout" value="False" /> | |
| 140 <output name="counts" file="htseq-test_counts.tsv" /> | |
|
3
f7a5b54a8d4f
Split feature and non-feature counts, removed tool_dependencies.xml (for now)
Lance Parsons <lparsons@princeton.edu>
parents:
0
diff
changeset
|
141 <output name="othercounts" file="htseq-test_othercounts.tsv" /> |
| 0 | 142 </test> |
|
10
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
143 <test> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
144 <param name="samfile" value="htseq-test-paired.bam" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
145 <param name="singlepaired" value="paired" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
146 <param name="gfffile" value="htseq-test.gff" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
147 <param name="samout" value="False" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
148 <output name="counts" file="htseq-test-paired_counts.tsv" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
149 <output name="othercounts" file="htseq-test-paired_othercounts.tsv" /> |
|
5d969cb56112
Version 0.3 - paried-end sorting is now built-in (uses Picard tools)
lparsons
parents:
9
diff
changeset
|
150 </test> |
| 0 | 151 <!-- Seems to be an issue setting the $reference_fasta_filename variable during test |
| 152 <test> | |
| 153 <param name="samfile" value="htseq-test.sam" /> | |
| 154 <param name="gfffile" value="htseq-test.gff" /> | |
| 155 <param name="samout" value="True" /> | |
| 156 <param name="reference_source_selector" value="history" /> | |
| 157 <param name="ref_file" value="htseq-test_reference.fasta" /> | |
| 158 <output name="counts" file="htseq-test_counts.tsv" /> | |
|
3
f7a5b54a8d4f
Split feature and non-feature counts, removed tool_dependencies.xml (for now)
Lance Parsons <lparsons@princeton.edu>
parents:
0
diff
changeset
|
159 <output name="othercounts" file="htseq-test_othercounts.tsv" /> |
| 0 | 160 <output name="samoutfile" file="htseq-test_samout.bam" /> |
| 161 </test> | |
| 162 --> | |
| 163 </tests> | |
| 164 | |
| 165 <help> | |
| 166 Overview | |
| 167 -------- | |
| 168 | |
| 169 This tool takes an alignment file in SAM or BAM format and feature file in GFF format | |
| 170 and calculates the number of reads mapping to each feature. It uses the *htseq-count* | |
| 171 script that is part of the HTSeq python module. See | |
| 172 http://www-huber.embl.de/users/anders/HTSeq/doc/count.html for details. | |
| 173 | |
| 174 A feature is an interval (i.e., a range of positions) on a chromosome or a union of | |
| 175 such intervals. In the case of RNA-Seq, the features are typically genes, where | |
| 176 each gene is considered here as the union of all its exons. One may also consider | |
| 177 each exon as a feature, e.g., in order to check for alternative splicing. For | |
| 178 comparative ChIP-Seq, the features might be binding regions from a pre-determined | |
| 179 list. | |
| 180 | |
| 181 | |
| 182 Overlap Modes | |
| 183 ------------- | |
| 184 | |
| 185 Special care must be taken to decide how to deal with reads that overlap more than one feature. | |
| 186 | |
| 187 The htseq-count script allows to choose between three modes: *union*, *intersection-strict*, and *intersection-nonempty*. | |
| 188 | |
| 189 The following figure illustrates the effect of these three modes: | |
| 190 | |
| 191 .. image:: /static/images/count_modes.png | |
| 192 :width: 500 | |
| 193 | |
| 11 | 194 |
| 0 | 195 Strandedness |
| 196 ------------ | |
| 197 | |
| 198 **Important**: The default for strandedness is yes. If your RNA-Seq data has not been made with a strand-specific protocol, this causes half of the reads to be lost. Hence, make sure to set the option Stranded to 'No' unless you have strand-specific data! | |
| 199 | |
| 11 | 200 |
| 0 | 201 Output |
| 202 ------ | |
| 203 | |
| 204 The script outputs a table with counts for each feature, followed by the special counters, which count reads that were not counted for any feature for various reasons, namely | |
| 205 | |
| 206 - *no_feature*: reads which could not be assigned to any feature (set S as described above was empty). | |
| 207 | |
| 208 - *ambiguous*: reads which could have been assigned to more than one feature and hence were not counted for any of these (set S had mroe than one element). | |
| 209 | |
| 210 - *too_low_aQual*: reads which were not counted due to the -a option, see below | |
| 211 | |
| 212 - *not_aligned*: reads in the SAM file without alignment | |
| 213 | |
| 214 - *alignment_not_unique*: reads with more than one reported alignment. These reads are recognized from the NH optional SAM field tag. (If the aligner does not set this field, multiply aligned reads will be counted multiple times.) | |
| 215 | |
| 216 | |
| 217 Options Summary | |
| 218 --------------- | |
| 219 | |
| 220 Usage: htseq-count [options] sam_file gff_file | |
| 221 | |
| 222 This script takes an alignment file in SAM format and a feature file in GFF | |
| 223 format and calculates for each feature the number of reads mapping to it. See | |
| 224 http://www-huber.embl.de/users/anders/HTSeq/doc/count.html for details. | |
| 225 | |
| 226 Options: | |
| 227 -h, --help show this help message and exit | |
| 228 -m MODE, --mode=MODE mode to handle reads overlapping more than one | |
| 229 feature(choices: union, intersection-strict, | |
| 230 intersection-nonempty; default: union) | |
| 231 -s STRANDED, --stranded=STRANDED | |
| 232 whether the data is from a strand-specific assay. | |
| 233 Specify 'yes', 'no', or 'reverse' (default: yes). | |
| 234 'reverse' means 'yes' with reversed strand | |
| 235 interpretation | |
| 236 -a MINAQUAL, --minaqual=MINAQUAL | |
| 237 skip all reads with alignment quality lower than the | |
| 238 given minimum value (default: 0) | |
| 239 -t FEATURETYPE, --type=FEATURETYPE | |
| 240 feature type (3rd column in GFF file) to be used, all | |
| 241 features of other type are ignored (default, suitable | |
| 242 for Ensembl GTF files: exon) | |
| 243 -i IDATTR, --idattr=IDATTR | |
| 244 GFF attribute to be used as feature ID (default, | |
| 245 suitable for Ensembl GTF files: gene_id) | |
| 246 -o SAMOUT, --samout=SAMOUT | |
| 247 write out all SAM alignment records into an output SAM | |
| 248 file called SAMOUT, annotating each line with its | |
| 249 feature assignment (as an optional field with tag | |
| 250 'XF') | |
| 251 -q, --quiet suppress progress report and warnings | |
| 252 | |
| 253 Written by Simon Anders (sanders@fs.tum.de), European Molecular Biology | |
| 254 Laboratory (EMBL). (c) 2010. Released under the terms of the GNU General | |
| 255 Public License v3. Part of the 'HTSeq' framework. | |
| 256 </help> | |
| 257 </tool> |