.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH FEATURECOUNTS "1" "March 2021" "featureCounts 2.0.1" "User Commands"
.SH NAME
featureCounts \- toolkit for processing next-gen sequencing data
.SH SYNOPSIS
.B featureCounts
[\fI\,options\/\fR] \fI\,-a <annotation_file> -o <output_file> input_file1 \/\fR[\fI\,input_file2\/\fR] ...
.SH DESCRIPTION
Version 2.0.1
.PP
## Mandatory arguments:
.TP
\fB\-a\fR <string>
Name of an annotation file. GTF/GFF format by default. See
\fB\-F\fR option for more format information. Inbuilt annotations
(SAF format) is available in 'annotation' directory of the
package. Gzipped file is also accepted.
.TP
\fB\-o\fR <string>
Name of output file including read counts. A separate file
including summary statistics of counting results is also
included in the output ('<string>.summary'). Both files
are in tab delimited format.
.TP
input_file1 [input_file2] ...
A list of SAM or BAM format files. They can be
.TP
either name or location sorted. If no files provided,
<stdin> input is expected. Location\-sorted paired\-end reads
are automatically sorted by read names.
.PP
## Optional arguments:
# Annotation
.TP
\fB\-F\fR <string>
Specify format of the provided annotation file. Acceptable
formats include 'GTF' (or compatible GFF format) and
\&'SAF'. 'GTF' by default.  For SAF format, please refer to
Users Guide.
.TP
\fB\-t\fR <string>
Specify feature type(s) in a GTF annotation. If multiple
types are provided, they should be separated by ',' with
no space in between. 'exon' by default. Rows in the
annotation with a matched feature will be extracted and
used for read mapping.
.TP
\fB\-g\fR <string>
Specify attribute type in GTF annotation. 'gene_id' by
default. Meta\-features used for read counting will be
extracted from annotation using the provided value.
.TP
\fB\-\-extraAttributes\fR
Extract extra attribute types from the provided GTF
annotation and include them in the counting output. These
attribute types will not be used to group features. If
more than one attribute type is provided they should be
separated by comma.
.TP
\fB\-A\fR <string>
Provide a chromosome name alias file to match chr names in
annotation with those in the reads. This should be a twocolumn comma\-delimited text file. Its first column should
include chr names in the annotation and its second column
should include chr names in the reads. Chr names are case
sensitive. No column header should be included in the
file.
.PP
# Level of summarization
.TP
\fB\-f\fR
Perform read counting at feature level (eg. counting
reads for exons rather than genes).
.PP
# Overlap between reads and features
.TP
\fB\-O\fR
Assign reads to all their overlapping meta\-features (or
features if \fB\-f\fR is specified).
.TP
\fB\-\-minOverlap\fR <int>
Minimum number of overlapping bases in a read that is
required for read assignment. 1 by default. Number of
overlapping bases is counted from both reads if paired
end. If a negative value is provided, then a gap of up
to specified size will be allowed between read and the
feature that the read is assigned to.
.TP
\fB\-\-fracOverlap\fR <float> Minimum fraction of overlapping bases in a read that is
required for read assignment. Value should be within range
[0,1]. 0 by default. Number of overlapping bases is
counted from both reads if paired end. Both this option
and '\-\-minOverlap' option need to be satisfied for read
assignment.
.TP
\fB\-\-fracOverlapFeature\fR <float> Minimum fraction of overlapping bases in a
feature that is required for read assignment. Value
should be within range [0,1]. 0 by default.
.TP
\fB\-\-largestOverlap\fR
Assign reads to a meta\-feature/feature that has the
largest number of overlapping bases.
.TP
\fB\-\-nonOverlap\fR <int>
Maximum number of non\-overlapping bases in a read (or a
read pair) that is allowed when being assigned to a
feature. No limit is set by default.
.TP
\fB\-\-nonOverlapFeature\fR <int> Maximum number of non\-overlapping bases in a feature
that is allowed in read assignment. No limit is set by
default.
.TP
\fB\-\-readExtension5\fR <int> Reads are extended upstream by <int> bases from their
5' end.
.TP
\fB\-\-readExtension3\fR <int> Reads are extended upstream by <int> bases from their
3' end.
.TP
\fB\-\-read2pos\fR <5:3>
Reduce reads to their 5' most base or 3' most base. Read
counting is then performed based on the single base the
read is reduced to.
.PP
# Multi\-mapping reads
.TP
\fB\-M\fR
Multi\-mapping reads will also be counted. For a multimapping read, all its reported alignments will be
counted. The 'NH' tag in BAM/SAM input is used to detect
multi\-mapping reads.
.PP
# Fractional counting
.TP
\fB\-\-fraction\fR
Assign fractional counts to features. This option must
be used together with '\-M' or '\-O' or both. When '\-M' is
specified, each reported alignment from a multi\-mapping
read (identified via 'NH' tag) will carry a fractional
count of 1/x, instead of 1 (one), where x is the total
number of alignments reported for the same read. When '\-O'
is specified, each overlapping feature will receive a
fractional count of 1/y, where y is the total number of
features overlapping with the read. When both '\-M' and
\&'\-O' are specified, each alignment will carry a fractional
count of 1/(x*y).
.PP
# Read filtering
.TP
\fB\-Q\fR <int>
The minimum mapping quality score a read must satisfy in
order to be counted. For paired\-end reads, at least one
end should satisfy this criteria. 0 by default.
.TP
\fB\-\-splitOnly\fR
Count split alignments only (ie. alignments with CIGAR
string containing 'N'). An example of split alignments is
exon\-spanning reads in RNA\-seq data.
.TP
\fB\-\-nonSplitOnly\fR
If specified, only non\-split alignments (CIGAR strings do
not contain letter 'N') will be counted. All the other
alignments will be ignored.
.TP
\fB\-\-primary\fR
Count primary alignments only. Primary alignments are
identified using bit 0x100 in SAM/BAM FLAG field.
.TP
\fB\-\-ignoreDup\fR
Ignore duplicate reads in read counting. Duplicate reads
are identified using bit Ox400 in BAM/SAM FLAG field. The
whole read pair is ignored if one of the reads is a
duplicate read for paired end data.
.PP
# Strandness
.TP
\fB\-s\fR <int or string>
Perform strand\-specific read counting. A single integer
value (applied to all input files) or a string of commaseparated values (applied to each corresponding input
file) should be provided. Possible values include:
0 (unstranded), 1 (stranded) and 2 (reversely stranded).
Default value is 0 (ie. unstranded read counting carried
out for all input files).
.PP
# Exon\-exon junctions
.TP
\fB\-J\fR
Count number of reads supporting each exon\-exon junction.
Junctions were identified from those exon\-spanning reads
in the input (containing 'N' in CIGAR string). Counting
results are saved to a file named '<output_file>.jcounts'
.TP
\fB\-G\fR <string>
Provide the name of a FASTA\-format file that contains the
reference sequences used in read mapping that produced the
provided SAM/BAM files. This optional argument can be used
with '\-J' option to improve read counting for junctions.
.PP
# Parameters specific to paired end reads
.TP
\fB\-p\fR
If specified, fragments (or templates) will be counted
instead of reads. This option is only applicable for
paired\-end reads; single\-end reads are always counted as
reads.
.TP
\fB\-B\fR
Only count read pairs that have both ends aligned.
.TP
\fB\-P\fR
Check validity of paired\-end distance when counting read
pairs. Use \fB\-d\fR and \fB\-D\fR to set thresholds.
.TP
\fB\-d\fR <int>
Minimum fragment/template length, 50 by default.
.TP
\fB\-D\fR <int>
Maximum fragment/template length, 600 by default.
.TP
\fB\-C\fR
Do not count read pairs that have their two ends mapping
to different chromosomes or mapping to same chromosome
but on different strands.
.TP
\fB\-\-donotsort\fR
Do not sort reads in BAM/SAM input. Note that reads from
the same pair are required to be located next to each
other in the input.
.PP
# Number of CPU threads
.TP
\fB\-T\fR <int>
Number of the threads. 1 by default.
.PP
# Read groups
.TP
\fB\-\-byReadGroup\fR
Assign reads by read group. "RG" tag is required to be
present in the input BAM/SAM files.
.PP
# Long reads
.TP
\fB\-L\fR
Count long reads such as Nanopore and PacBio reads. Long
read counting can only run in one thread and only reads
(not read\-pairs) can be counted. There is no limitation on
the number of 'M' operations allowed in a CIGAR string in
long read counting.
.PP
# Assignment results for each read
.TP
\fB\-R\fR <format>
Output detailed assignment results for each read or readpair. Results are saved to a file that is in one of the
following formats: CORE, SAM and BAM. See Users Guide for
more info about these formats.
.TP
\fB\-\-Rpath\fR <string>
Specify a directory to save the detailed assignment
results. If unspecified, the directory where counting
results are saved is used.
.PP
# Miscellaneous
.TP
\fB\-\-tmpDir\fR <string>
Directory under which intermediate files are saved (later
removed). By default, intermediate files will be saved to
the directory specified in '\-o' argument.
.TP
\fB\-\-maxMOp\fR <int>
Maximum number of 'M' operations allowed in a CIGAR
string. 10 by default. Both 'X' and '=' are treated as 'M'
and adjacent 'M' operations are merged in the CIGAR
string.
.TP
\fB\-\-verbose\fR
Output verbose information for debugging, such as unmatched chromosome/contig names.
.TP
\fB\-v\fR
Output version of the program.
.SH AUTHOR
 This manpage was written by Nilesh Patra for the Debian distribution and
 can be used for any other usage of the program.