Skip to main content

BAM to bedGraph

bam-to-bedgraph

Convert BAM file to bedGraph file like a genome-wide pileup.

File input (BAM)​

This script processes BAM-type files so make sure your input is properly formatted and uses the appropriate .bam extension if you are working from the GUI.

caution

Make sure your BAM input files are sorted and indexed.

Read Encoding Options​

This tool has multiple read options to output.

  • Read 1: output Read 1 (5' end)
  • Read 2: output Read 2 (5' end)
  • Combined: output both reads (5' end)
  • Midpoint: output the midpoint between reads
note

The Midpoint option requires proper mate-pair reading.

Filter Options​

  • Require Proper Paired-End refers to the proper pairing of reads Read 1 and Reads 2.
  • Filter Min Insert Size (bp) refers to the minimum insert size to filter
  • Filter Max Insert Size (bp) refers to the maximum insert size to filter

Output format (bedGraph)​

The genome-wide tag pileup of each BAM entry is written to the bedGraph format. The output may be either a single _combined.bedgraph file or two stranded _forward.bedgraph and _reverse.bedgraph files. The basename that this suffix and extension is appended to is derived from the BAM filename with the read encoding information. For example, given an input BAM filename, mybam.bam, the following output files will be produced for each read encoding option:

  • Read 1 example: mybam_READ1_forward.bedgraph and mybam_READ1_reverse.bedgraph
  • Read 2 example: mybam_READ2_forward.bedgraph and mybam_READ2_reverse.bedgraph
  • Combined example: mybam_COMBINED_combined.bedgraph
  • Midpoint example: mybam_MIDPOINT_combined.bedgraph

Output GZip​

Toggling this allows the user to write output to a compressed file format using a general compression (gzip) which has the added advantage of speeding up the execution time by shrinking the I/O load (esp for large output). The .gz extension will be appended as appropriate.

Command Line Interface​

Usage:

java -jar ScriptManager.jar bam-format-converter bam-to-bedgraph [-1 | -2 | -a | -m]
[-hpV] [-n=<MIN_INSERT>] [-o=<outputBasename>] [-x=<MAX_INSERT>]
<bamFile>

Positional Input​

This tool takes a single BAM file for input. As with other tools, this tool requires the BAM file be indexed.

Output Options​

OptionDescription
-o, --output=<outputBasename>specify output directory (name will be same as original with _<strand>.bedgraph ext)
-s, --stdoutstream output file to STDOUT (cannot be used with -o flag)
-z, --gzipgzip output (default=false)

Filter Options​

These filter options are shared across all the BAM Format Converter tools.

OptionDescription
-p, --mate-pairrequire proper mate pair (default not required)
-n, --min-insert=<MIN_INSERT>filter by min insert size in bp
-x, --max-insert=<MAX_INSERT>filter by max insert size in bp

Read Options​

OptionDescription
-1, --read1output read 1 (default)
-2, --read2output read 2
-a, --all-readsoutput combined
-m, --midpointoutput midpoint (require PE)