Changes

From Genome Analysis Wiki
Jump to navigationJump to search

BamUtil: stats (view source)

Revision as of 15:59, 24 August 2017

10,818 bytes added ,  15:59, 24 August 2017
→‎BaseQC (--pBaseQC and --cBaseQC and --baseSum)
Line 1: Line 1: −
[[Category:BamUtil|stats]]
+
<br>
−
[[Category:BAM Software]]
  −
[[Category:Software]]
     −
= Overview of the <code>stats</code> function of <code>bamUtil</code> =
+
= Overview of the <code>stats</code> function of <code>bamUtil</code> =
−
The <code>stats</code> option on the [[bamUtil]] executable generates the specified statistics on a SAM/BAM file.
     −
= Parameters =
+
The <code>stats</code> option on the [[BamUtil]] executable generates the specified statistics on a SAM/BAM file.
 +
 
 +
== Troubleshooting ==
 +
See [[BamUtil:_FAQ#BamUtil:_stats|BamUtil: FAQ -> BamUtil: stats]] for troubleshooting help.
 +
 
 +
= Usage =
 
<pre>
 
<pre>
−
Required Parameters:
+
./bam stats --in <inputFile> [--basic] [--qual] [--phred] [--pBaseQC <outputFileName>] [--cBaseQC <outputFileName>] [--maxNumReads <maxNum>][--unmapped] [--bamIndex <bamIndexFile>] [--regionList <regFileName>] [--requiredFlags <integerRequiredFlags>] [--excludeFlags <integerExcludeFlags>] [--noeof] [--params] [--withinRegion] [--baseSum] [--bufferSize <buffSize>] [--minMapQual <minMapQ>] [--dbsnp <dbsnpFile>]
−
--in : the SAM/BAM file to calculate stats for
  −
Types of Statistics that can be generated:
  −
--basic       : Turn on basic statistic generation
  −
--qual       : Generate a count for each quality (displayed as non-phred quality)
  −
--phred      : Generate a count for each quality (displayed as phred quality)
  −
--baseQC      : Write per base statistics to the specified file.
  −
Optional Parameters:
  −
--maxNumReads : Maximum number of reads to process
  −
                Defaults to -1 to indicate all reads.
  −
--unmapped   : Only process unmapped reads (requires a bamIndex file)
  −
--bamIndex   : The path/name of the bam index file
  −
                (if required and not specified, uses the --in value + ".bai")
  −
--regionList : File containing the region list chr<tab>start_pos<tab>end<pos>.
  −
                Positions are 0 based and the end_pos is not included in the region.
  −
                Uses bamIndex.
  −
--minMapQual  : The minimum mapping quality for filtering reads in the baseQC stats.
  −
--dbsnp      : The dbSnp file of positions to exclude from baseQC analysis.
  −
--noeof      : Do not expect an EOF block on a bam file.
  −
--params      : Print the parameter settings
   
</pre>
 
</pre>
   −
For all types of statistics, the bam file used is specified by <code>--in</code>.
+
= Parameters  =
 +
<pre>
 +
        Required Parameters:
 +
                --in : the SAM/BAM file to calculate stats for
 +
        Types of Statistics that can be generated:
 +
                --basic        : Turn on basic statistic generation
 +
                --qual          : Generate a count for each quality (displayed as non-phred quality)
 +
                --phred        : Generate a count for each quality (displayed as phred quality)
 +
                --pBaseQC      : Write per base statistics as Percentages to the specified file. (use - for stdout)
 +
                                  pBaseQC & cBaseQC cannot both be specified.
 +
                --cBaseQC      : Write per base statistics as Counts to the specified file. (use - for stdout)
 +
                                  pBaseQC & cBaseQC cannot both be specified.
 +
        Optional Parameters:
 +
                --maxNumReads  : Maximum number of reads to process
 +
                                  Defaults to -1 to indicate all reads.
 +
                --unmapped      : Only process unmapped reads (requires a bamIndex file)
 +
                --bamIndex      : The path/name of the bam index file
 +
                                  (if required and not specified, uses the --in value + ".bai")
 +
                --regionList    : File containing the regions to be processed chr<tab>start_pos<tab>end_pos.
 +
                                  Positions are 0 based and the end_pos is not included in the region.
 +
                                  Uses bamIndex.
 +
                --excludeFlags  : Skip any records with any of the specified flags set
 +
                                  (specify an integer representation of the flags)
 +
                --requiredFlags : Only process records with all of the specified flags set
 +
                                  (specify an integer representation of the flags)
 +
                --noeof        : Do not expect an EOF block on a bam file.
 +
                --params        : Print the parameter settings.
 +
        Optional phred/qual Only Parameters:
 +
                --withinRegion  : Only count qualities if they fall within regions specified.
 +
                                  Only applicable if regionList is also specified.
 +
        Optional BaseQC Only Parameters:
 +
                --baseSum      : Print an overall summary of the baseQC for the file to stderr.
 +
                --bufferSize    : Size of the pileup buffer for calculating the BaseQC parameters.
 +
                                  Default: 1024
 +
                --minMapQual    : The minimum mapping quality for filtering reads in the baseQC stats.
 +
                --dbsnp        : The dbSnp file of positions to exclude from baseQC analysis.
 +
</pre>  
 +
{{PhoneHomeParamDesc}}
   −
The optional parameters are also used for all types of statistics.
+
== Required Parameters ==
   −
Usage:
+
{{inBAMInputFile}}
−
<pre>
+
 
−
./bam stats --in <inputFile> [--basic] [--qual] [--phred] [--baseQC <outputFileName>] [--maxNumReads <maxNum>] [--unmapped] [--bamIndex <bamIndexFile>] [--regionList <regFileName>] [--minMapQual <minMapQ>] [--dbsnp <dbsnpFile>] [--noeof] [--params]
+
== Optional Parameters ==
−
</pre>
+
===  Maximum number of reads to process(<code>--maxNumReads</code>) ===
 +
Use <code>--maxNumReads</code> followed by a number to indicate the maximum number of reads to process before exiting.  By default, it is set to -1 to indicate all reads should be processed.
 +
 
 +
=== Only Process Unmapped Reads (<code>--unmapped</code>) ===
 +
Use <code>--unmapped</code> to process only unmapped reads.
 +
 
 +
This parameter requires [[#Bam Index File (--bamIndex)|<code>--bamIndex</code>]].
 +
 
 +
{{BamIndex}}
 +
 
 +
=== Only Process Certain Regions (<code>--regionList</code>) ===
 +
Use <code>--regionList</code> followed by the filename to process only the regions specified in the file.
 +
 
 +
The positions in the file are specified one per line with the following format: <nowiki>chr<tab>start_pos<tab>end_pos.</nowiki>
 +
 
 +
Positions are 0 based and the end_pos is not included in the region.
 +
 
 +
This parameter requires [[#Bam Index File (--bamIndex)|<code>--bamIndex</code>]].
 +
 
 +
=== Exclude Flags (<code>--excludeFlags</code>) ===
 +
Use <code>--excludeFlags</code> followed by an integer representation of the flags to only process reads with any of the specified flags set.
 +
 
 +
=== Required Flags (<code>--requiredFlags</code>) ===
 +
Use <code>--requiredFlags</code> followed by an integer representation of the flags to only process records with all of the specified flags set.
    +
== Types of Statistics ==
    +
=== Basic (<code>--basic</code>) ===
   −
= Types of Statistics =
+
Prints summary statistics for the file:
   −
== Basic ==
+
*TotalReads - # of reads that are in the file  
−
Prints summary statistics for the file:
+
*MappedReads - # of reads marked mapped in the flag  
−
*TotalReads - # of reads that are in the file
+
*PairedReads - # of reads marked paired in the flag  
−
*MappedReads - # of reads marked mapped in the flag
+
*ProperPair - # of reads marked paired AND proper paired in the flag  
−
*PairedReads - # of reads marked paired in the flag
+
*DuplicateReads - # of reads marked duplicate in the flag  
−
*ProperPair - # of reads marked paired AND proper paired in the flag
+
*QCFailureReads - # of reads marked QC failure in the flag  
−
*DuplicateReads - # of reads marked duplicate in the flag
+
*MappingRate(%) - # of reads marked mapped in the flag / TotalReads  
−
*QCFailureReads - # of reads marked QC failure in the flag
+
*PairedReads(%) - # of reads marked paired in the flag / TotalReads  
−
*MappingRate(%) - # of reads marked mapped in the flag / TotalReads
+
*ProperPair(%) - # of reads marked paired AND proper paired in the flag / TotalReads  
−
*PairedReads(%) - # of reads marked paired in the flag / TotalReads
+
*DupRate(%) - # of reads marked duplicate in the flag / TotalReads  
−
*ProperPair(%) - # of reads marked paired AND proper paired in the flag / TotalReads
+
*QCFailRate(%) - # of reads marked QC failure in the flag / TotalReads  
−
*DupRate(%) - # of reads marked duplicate in the flag / TotalReads
+
*TotalBases - # of bases in all reads  
−
*QCFailRate(%) - # of reads marked QC failure in the flag / TotalReads
  −
*TotalBases - # of bases in all reads
   
*BasesInMappedReads - # of bases in reads marked mapped in the flag
 
*BasesInMappedReads - # of bases in reads marked mapped in the flag
   −
== Qual/Phred ==
+
=== Qual/Phred (<code>--phred</code> and <code>--qual</code>) ===
−
Prints a count of the number of times each quality value appears in the file.
  −
*<code>phred</code> Displays Quality as phred integers [0-93]
  −
*<code>qual</code> Displays Quality as non-phred integers (phred + 33) [33-126]
  −
 
     −
== BaseQC ==
+
Prints a count of the number of times each quality value appears in the file to stderr.
   −
The <code>baseQC</code> option generates the following statistics:
+
*<code>phred</code> Displays Quality as phred integers [0-93]
 +
*<code>qual</code> Displays Quality as non-phred integers (phred + 33) [33-126]
   −
For each position, the following counts are incremented if:
+
By default, these counts include all qualities in the BAM file.
−
# a read spans the reference position (starts before or at this reference position and ends at or after this position)
  −
# regardless of duplicate/qc failure/unmapped/mapping quality
  −
# if CIGAR for this position is M/X/=/D/N (any cigar other than clip or insert)
  −
*TotalReads - # of reads that span this position.  
  −
*Dups - # of reads marked duplicate in the flag
  −
*QCFail - # of reads marked QC failure in the flag
     −
No further stats are incremented if the read is a duplicate, QC failure, or unmapped.
+
To exclude unmapped reads and soft clips, use --excludeFlags 4.
   −
Additional counts incremented ONLY for mapped, non-duplicate, non-QC failure reads:
+
To only include records that overlap a set of regions, use --regionList and specify a bed file with the regions.  If a read overlaps the region, all qualities will be counted even if those bases do not fall in the region.  If you only want to count qualities that fall within the region, also specify --withinRegion.  Without excluding unmapped reads, it will include soft clips that overlap the region.
−
*Mapped - # of reads marked mapped in the flag
  −
*Paired - # of reads marked paired in the flag
  −
*ProperPaired - # of reads marked paired AND proper paired in the flag
  −
*ZeroMapQual - # of reads that have a Mapping Quality of 0
  −
*MapQual<10 - # of reads that have a Mapping Quality < 10
  −
*MapQual255 - # of reads that have a Mapping Quality = 255
  −
*PassMapQual - # of reads that have a Mapping Quality >= a minimum Mapping Quality (version 1.0, this includes mapping quality 255 reads).
     −
Additional values ONLY for mapped, mapping quality != 255, non-duplicate, non-QC failure reads:
+
==== Optional Phred/Qual Only Parameters ====
−
*AverageMapQuality - average calculated by summing all mapping qualities that are included (as defined above) and dividing by the number of mapping qualities added.
+
===== Within Region (<code>--withinRegion</code>) =====
−
*AverageMapQualCount - # of mapping qualities used to calculate AverageMapQuality.
+
Use <code>--withinRegion</code> with [[#Qual/Phred (--phred and --qual)|<code>--phred</code> or <code>--qual</code>]] options to only count qualities if they fall within the regions specified using [[#Only Process Certain Regions (--regionList)|<code>--regionList</code>]] (only applicable if [[#Only Process Certain Regions (--regionList)|<code>--regionList</code>]]  is also specified).
   −
Additional values ONLY incremented for mapped, mapping quality >= min mapping quality, non-duplicate, non-QC failure reads (version 1.0, this includes mapping quality 255 reads):
+
=== BaseQC (<code>--pBaseQC</code> and <code>--cBaseQC</code> and <code>--baseSum</code>) ===
−
*Depth - # of reads. 
  −
*Q20Bases - # of bases at this position with a base quality (from the read) of Q20 or higher.
     −
Currently there is no special logic to exclude positions where the refernce is 'N'.
+
The <code>pBaseQC</code> and <code>cBaseQC</code> options generate per base statistics.  Only one of these two options can be specified.  They write statistics generated for each position to the file specified after the option (use <code>-</code> to write to STDOUT).  They use the same logic for calculating statistics, but <code>pBaseQC</code> writes the statistics as percentages, and <code>cBaseQC</code> writes them as counts.  The order of the statistics are also different.
   −
Currently there is no special logic to exclude reads from the counts when the base is 'N'.
+
The <code>baseSum</code> option can be used with either <code>pBaseQC</code> or <code>cBaseQC</code> or on its own.  <code>baseSum</code> generates a summary of the per position statistics and writes it to stderr.  It calculates the per position base statistics even if they will not be written anywhere (neither <code>pBaseQC</code> nor <code>cBaseQC</code> are specified).
      −
=== BaseQC Output ===
+
All three options use the same logic for calculating the statistics:
−
There are two output options for BaseQC.
+
* A read spans a position if the read starts at or before the position, ends at or after the position and the position is not a clip.  CIGAR operations allowed for the position are M/X/=/D/N.  If the CIGAR is '*', only numbers for the specified reference position are incremented.
−
# Percentages
+
*Currently there is no special logic to exclude positions/reads where the reference base is 'N' or the read base is 'N'.
−
# Straight Counts
     −
==== Percentage-Based Output Format ====
+
<br>
−
Order (with calculations based on the values described above):
  −
*chrom - Chromosome/reference name string from the SAM/BAM
  −
*chromStart - 0-based start position
  −
*chromEnd  - 0-based end position (always 1 greater than start and not included in this region)
  −
*Depth - Depth
  −
*Q20Bases - Q20Bases
  −
*Q20BasesPct(%) - Q20Bases / Depth
  −
*TotalReads - TotalReads
  −
*MappedBases - Mapped
  −
*MappingRate(%) - Mapped / TotalReads
  −
*MapRate_MQPass(%) - PassMapQual / TotalReads
  −
*ZeroMapQual(%) - ZeroMapQual / TotalReads
  −
*MapQual<10(%) - MapQual<10 / TotalReads
  −
*PairedReads(%) - Paired / TotalReads
  −
*ProperPaired(%) - ProperPaired / TotalReads
  −
*DupRate(%) - Dups / TotalReads
  −
*QCFailRate(%) - QCFail / TotalReads
  −
*AverageMapQuality - AverageMapQuality
  −
*AverageMapQualCount - AverageMapQualCount
     −
This output does not include a MapQual255 count in version 1.0.
+
==== Percentage-Based Output Format (<code>--pBaseQC</code>) ====
    +
Order/Descriptions:
   −
==== Count-Based Output Format ====
+
{|border=1
−
Order (of values described above):
+
! Field !! Description !!style="width: 80px"| Excludes Duplicates, QC Failures !!style="width: 80px"| Excludes Unmapped !!style="width: 80px"|  Excludes MapQual = 255 !!style="width: 80px"| Excludes Below Min MapQual !!style="width: 80px"| Excludes CIGAR Deletions, Skips
−
*chrom - Chromosome/reference name string from the SAM/BAM
+
|-
−
*chromStart - 0-based start position  
+
| chrom || Chromosome/reference name string from the SAM/BAM
−
*chromEnd - 0-based end position (always 1 greater than start and not included in this region)
+
|-
−
*TotalReads
+
| chromStart || 0-based start position
−
*Dups
+
|-
−
*QCFail
+
| chromEnd || 0-based end position (always 1 greater than start and not included in this region)
−
*Mapped
+
|-
−
*Paired
+
| Depth || # of reads that are mapped with acceptable Mapping Quality, and are not duplicates or QC failures || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
−
*ProperPaired
+
|-
−
*ZeroMapQual
+
| Q20Bases || # of bases at this position with a base quality (from the read) of Q20 or higher || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
−
*MapQual<10
+
|-
−
*MapQual255
+
| Q20BasesPct(%) || Q20Bases / Depth || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
−
*PassMapQual
+
|-
−
*AverageMapQuality
+
| TotalReads || # of reads that span this position || || || || ||
−
*AverageMapQualCount
+
|-
−
*Depth
+
| MappedBases || # of reads marked mapped in the flag || align="center"|X || align="center"|X || || ||
−
*Q20Bases
+
|-
 +
| MappingRate(%) || MappedBases / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapRate_MQPass(%) || # of reads that have a Mapping Quality &gt;= a minimum Mapping Quality / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ZeroMapQual(%) || # of reads that have a Mapping Quality of 0 / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapQual&lt;10(%) || # of reads that have a Mapping Quality &lt; 10 / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| PairedReads(%) || # of reads marked paired in the flag / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ProperPaired(%) || # of reads marked paired AND proper paired in the flag / TotalReads || align="center"|X || align="center"|X || || ||
 +
|-
 +
| DupRate(%) || # of reads marked duplicate in the flag / TotalReads || || || || ||
 +
|-
 +
| QCFailRate(%) || # of reads marked QC failure in the flag / TotalReads || || || || ||
 +
|-
 +
| AverageMapQuality || sum of included mapping qualities / AverageMapQualCount || align="center"|X || align="center"|X || align="center"|X || ||
 +
|-
 +
| AverageMapQualCount || # of mapping qualities in AverageMapQuality || align="center"|X || align="center"|X || align="center"|X || ||
 +
|-
 +
|}
    +
This output does not include a MapQual255 count.
   −
=== Sample Output ===
     −
<pre>
+
===== Sample Output  =====
−
chrom chromStart chromEnd Depth Q20Bases Q20BasesPct(%) TotalReads MappedBases MappingRate(%) MapRate_MQPass(%) ZeroMapQual(%) MapQual<10(%) PairedReads(%) ProperPaired(%) DupRate(%) QCFailRate(%) AverageMapQuality AverageMapQualCount
+
<pre>chrom chromStart chromEnd Depth Q20Bases Q20BasesPct(%) TotalReads MappedBases MappingRate(%) MapRate_MQPass(%) ZeroMapQual(%) MapQual&lt;10(%) PairedReads(%) ProperPaired(%) DupRate(%) QCFailRate(%) AverageMapQuality AverageMapQualCount
 
1 100 101 2 2 100.000 3 3 100.000 66.667 33.333 66.667 100.000 0.000 0.000 0.000 11.000 3
 
1 100 101 2 2 100.000 3 3 100.000 66.667 33.333 66.667 100.000 0.000 0.000 0.000 11.000 3
 
1 101 102 2 0 0.000 3 3 100.000 66.667 33.333 66.667 100.000 0.000 0.000 0.000 11.000 3
 
1 101 102 2 0 0.000 3 3 100.000 66.667 33.333 66.667 100.000 0.000 0.000 0.000 11.000 3
Line 168: Line 195:  
1 10023 10024 0 0 0.000 39 30 76.923 51.282 25.641 51.282 84.615 38.462 15.385 15.385 0.000 0
 
1 10023 10024 0 0 0.000 39 30 76.923 51.282 25.641 51.282 84.615 38.462 15.385 15.385 0.000 0
 
1 10024 10025 14 12 85.714 39 30 76.923 51.282 25.641 51.282 84.615 38.462 15.385 15.385 11.000 21
 
1 10024 10025 14 12 85.714 39 30 76.923 51.282 25.641 51.282 84.615 38.462 15.385 15.385 11.000 21
 +
</pre>
 +
 +
 +
==== Count-Based Output Format (<code>--cBaseQC</code>) ====
 +
Order/Descriptions:
 +
{|border=1
 +
! Field !! Description !!style="width: 80px"| Excludes Duplicates, QC Failures !!style="width: 80px"| Excludes Unmapped !!style="width: 80px"|  Excludes MapQual = 255 !!style="width: 80px"| Excludes Below Min MapQual !!style="width: 80px"| Excludes CIGAR Deletions, Skips
 +
|-
 +
| chrom || Chromosome/reference name string from the SAM/BAM
 +
|-
 +
| chromStart || 0-based start position
 +
|-
 +
| chromEnd || 0-based end position (always 1 greater than start and not included in this region)
 +
|-
 +
| TotalReads || # of reads that span this position || || || || ||
 +
|-
 +
| Dups || # of reads marked duplicate in the flag || || || || ||
 +
|-
 +
| QCFail || # of reads marked QC failure in the flag || || || || ||
 +
|-
 +
| Mapped || # of reads marked mapped in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| Paired || # of reads marked paired in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ProperPaired || # of reads marked paired AND proper paired in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ZeroMapQual || # of reads that have a Mapping Quality of 0 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapQual&lt;10(%) || # of reads that have a Mapping Quality &lt; 10 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapQual255 || # of reads that have a Mapping Quality = 255 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| PassMapQual || # of reads that have a Mapping Quality &gt;= a minimum Mapping Quality || align="center"|X || align="center"|X || || ||
 +
|-
 +
| AverageMapQuality || sum of included mapping qualities / AverageMapQualCount || align="center"|X || align="center"|X || align="center"|X || ||
 +
|-
 +
| AverageMapQualCount || # of mapping qualities in AverageMapQuality || align="center"|X || align="center"|X || align="center"|X ||
 +
|- ||
 +
| Depth || # of reads that are mapped with acceptable Mapping Quality, and are not duplicates or QC failures || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
 +
|-
 +
| Q20Bases || # of bases at this position with a base quality (from the read) of Q20 or higher || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
 +
|-
 +
|}
 +
 +
==== Summary of per Position Statistics (<code>--baseSum</code>) ====
 +
Use <code>--baseSum</code> to print an overall summary of the baseQC for the file to stderr.
 +
 +
This option can be used with or without <code>--pBaseQC</code> and <code>--cBaseQC</code>
 +
 +
The values are tab delimited.  First there is a header line describing the summary.  The next line has the Means, and the last line has the Standard Deviations.
 +
 +
{|border=1
 +
! Field !! Description !!style="width: 80px"| Excludes Duplicates, QC Failures !!style="width: 80px"| Excludes Unmapped !!style="width: 80px"|  Excludes MapQual = 255 !!style="width: 80px"| Excludes Below Min MapQual !!style="width: 80px"| Excludes CIGAR Deletions, Skips
 +
|-
 +
| TotalReads || # of reads that span this position || || || || ||
 +
|-
 +
| Dups || # of reads marked duplicate in the flag || || || || ||
 +
|-
 +
| QCFail || # of reads marked QC failure in the flag || || || || ||
 +
|-
 +
| Mapped || # of reads marked mapped in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| Paired || # of reads marked paired in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ProperPaired || # of reads marked paired AND proper paired in the flag || align="center"|X || align="center"|X || || ||
 +
|-
 +
| ZeroMapQual || # of reads that have a Mapping Quality of 0 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapQual&lt;10(%) || # of reads that have a Mapping Quality &lt; 10 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| MapQual255 || # of reads that have a Mapping Quality = 255 || align="center"|X || align="center"|X || || ||
 +
|-
 +
| PassMapQual || # of reads that have a Mapping Quality &gt;= a minimum Mapping Quality || align="center"|X || align="center"|X || || ||
 +
|-
 +
| AverageMapQuality || sum of included mapping qualities / AverageMapQualCount || align="center"|X || align="center"|X || align="center"|X || ||
 +
|-
 +
| AverageMapQualCount || # of mapping qualities in AverageMapQuality || align="center"|X || align="center"|X || align="center"|X ||
 +
|- ||
 +
| Depth || # of reads that are mapped with acceptable Mapping Quality, and are not duplicates or QC failures || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
 +
|-
 +
| Q20Bases || # of bases at this position with a base quality (from the read) of Q20 or higher || align="center"|X || align="center"|X || align="center"|X || align="center"|X || align="center"|X
 +
|-
 +
|}
 +
 +
 +
===== Sample Output =====
 +
<pre>
 +
Summary of Pileup Stats (1st Row is Mean, 2nd Row is Standard Deviation)
 +
TotalReads Dups QCFail Mapped Paired ProperPaired ZeroMapQual MapQual<10 MapQual255 PassMapQual AverageMapQuality AverageMapQualCount
 +
Depth Q20Bases
 +
14.307692 1.846154 1.846154 8.769231 7.846154 0.923077 2.923077 5.846154 0.000000 2.923077 11.000000 8.769231 2.076923 1.153846
 +
17.670053 2.882307 2.882307 9.038380 7.603137 1.441153 3.012793 6.025586 0.000000 3.012793 0.000000 9.038380 2.841993 1.993579
 
</pre>
 
</pre>
 +
 +
==== Optional BaseQC Only Parameters ====
 +
===== Pileup Buffer Size (<code>--bufferSize</code>) =====
 +
Use the <code>--bufferSize</code> option followed by the size of the pileup buffer to use for [[BaseQC (--pBaseQC and --cBaseQC and --baseSum)|baseQC]] stats.
 +
 +
===== Minimum Mapping Quality (<code>--minMapQual</code>) =====
 +
Use the <code>--minMapQual</code> option followed by the minimum mapping quality for filtering reads in the [[BaseQC (--pBaseQC and --cBaseQC and --baseSum)|baseQC]] stats.
 +
 +
===== DBSNP File (<code>--dbsnp</code>) =====
 +
Use the <code>--dbsnp</code> option followed by the name of the dbsnp file to specify the positions to exclude from [[BaseQC (--pBaseQC and --cBaseQC and --baseSum)|baseQC]] analysis.
 +
 +
{{PhoneHomeParameters}}
 +
 +
= Return Value =
 +
0 on Success, non-0 on failure
 +
 +
 +
[[Category:BamUtil|stats]] [[Category:BAM_Software]] [[Category:Software]]
Retrieved from "http://genome.sph.umich.edu/wiki/Special:MobileDiff/3910...14828"

Navigation menu