Skip to main content

GC-depth visualization

Python Version MIT license PyPI version Platform

GC depth visualization is a robust method for identifying contaminants in the genome. Since every taxon/species has different GC content, visualizing GC content alongside sequencing depth can indicate whether a genome contains a contaminant. Contaminants are always present at low sequencing depth and have different GC content from the host genome. Many published papers have already implemented GC-depth visualization, but none of them have published the script to visualize it. So, here I present a Python script to compute and visualize GC content vs sequencing depth per genomic window.

GC depth visualization

1. Install from PyPI

A very simple way to use this script is by installing it via Python PyPI.

pip install gc-depth

After installation is finished, type gc_depth -h to see the full help message.

$ gc_depth -h
Compute and visualize GC content versus sequencing depth per genomic window.

Usage: gc_depth <fasta> <pandepth_output> [options]

Positional arguments:
  fasta                Genome FASTA file (gzipped is also fine)
  pandepth             Pandepth windowed depth file (.win.stat.gz)

Options:
  -h, --help           Show this help message and exit
  -w, --window WINDOW  Window size, must match pandepth -w value (default: 1000)
  -o, --output OUTPUT  Output plot file (.png or .pdf, default: gc-depth.png)
  --log-depth          Use logarithmic scale for the depth axis
  --plot-only TSV      Skip processing, re-plot from an existing combined TSV (from --output-data)
  --output-data FILE   Save merged GC and depth data to this TSV file (can be reused with --plot-only)
  --version            Show the installed version and exit

2. Usage step by step

There are several upstream steps that you must do before running gc_depth. The main purpose of the initial step is to generate sequencing depth information in a specific window size.

2.1 Align raw reads to the genome

Short reads (Illumina or BGI/MGI-seq)

bwa index genome.fa
bwa mem -t 30 genome.fa reads_1.fq.gz reads_2.fq.gz > aligned.sam

PacBio HiFi reads

minimap2 -ax map-hifi -t 30 genome.fa reads.fq.gz > aligned.sam

Long reads (ONT or Cyclone-seq)

minimap2 -ax map-ont -t 30 genome.fa reads.fq.gz > aligned.sam

2.2 Process the SAM file into sorted BAM file

samtools view -Sb --threads 30 -o aligned.bam aligned.sam
samtools sort --threads 30 -o aligned.sorted.bam aligned.bam
samtools index aligned.sorted.bam

2.3 Run Pandepth to get depth information

The -w value here must match the --window value you pass to gc_depth. Read more about Pandepth.

pandepth -i aligned.sorted.bam -w 1000 -o depth

After successfully running Pandepth, you will get the output file: depth.win.stat.gz. Use this file and genome.fa file as gc_depth input file.

2.4 Run gc_depth

gc_depth genome.fa depth.win.stat.gz -w 1000

The default output file is gc-depth.png, If you want to change the output file as .pdf, you can just specify the output -o parameter to -o output.pdf.

3. Example

To get more familiar with the function of this script, I will demonstrate a real-world example of GC-depth visualization. Here, I use genome data from the red algae species Agarophyton chilense (Gracilaria chilensis). I downloaded the genomic data and raw reads from NCBI:

# genomic data
wget https://ftp.ncbi.nlm.nih.gov/genomes/all/GCA/030/374/765/GCA_030374765.1_ASM3037476v1/GCA_030374765.1_ASM3037476v1_genomic.fna.gz

# WGS raw reads
parallel-fastq-dump --sra-id SRR23519128 --threads 20 --outdir SRR23519128_reads --split-files --gzip

# map the raw reads to the genome
bwa index Gracilaria_chilensis.genome.fa
bwa mem -t 12 Gracilaria_chilensis.genome.fa Gracilaria_chilensis_WGS_1.fq.gz Gracilaria_chilensis_WGS_2.fq.gz > Gchilensis.aln.sam  
samtools view -Sb --threads 12 -o Gchilensis.aln.bam Gchilensis.aln.sam  
samtools sort --threads 12 -o Gchilensis.aln.sorted.bam Gchilensis.aln.bam  
samtools index Gchilensis.aln.sorted.bam

# run pandepth
pandepth -i Gchilensis.aln.sorted.bam -w 500 -o depth 

#run the python script
gc_depth Gracilaria_chilensis.genome.fa depth.win.stat.gz -w 500

Here is the final GC-depth plot output from the Python script.

GC depth visualization

Based on this figure, it is clear that there is no contamination in the genome. There is only one distinct GC peak and depth. If contamination were present, the figure would show more than one peak in GC content and average depth (top and right panels). Additionally, there would be multiple GC content densities in the main scatter plot. For more details on GC-depth use cases, read my Medium article.

4. Discussing

I will keep updating this repository. If you have any questions, fell free to reach me.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gc_depth-0.2.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gc_depth-0.2.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file gc_depth-0.2.0.tar.gz.

File metadata

  • Download URL: gc_depth-0.2.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gc_depth-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8eed2dbb69c0573eb378d57abf4d50d26d98e0da56ab9fc9cb76e661b4b54413
MD5 d0837c3444263b68c501e9d34840e7b4
BLAKE2b-256 b8474e320d144e5e074f9fe9fadc8d5753f37023096d380b989fd0dbe383e7c2

See more details on using hashes here.

File details

Details for the file gc_depth-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gc_depth-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gc_depth-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0efeb9f4c64ef5e6949fd82c46a3cab18affe388acd65cf56e93b7a6a0c2175a
MD5 47290fa4f081c6217a557affdf7a52ae
BLAKE2b-256 ca72e68f79f9ada24783eed66575952c1dc3f0c202068dc441d02107fffe301c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page