Skip to main content

Assess the quality of metagenome-assembled viral genomes.

Project description

Assessing the quality of metagenome-assembled viral genomes

Installation

There are two methods to install CheckV in your computer:

  • Using conda:
conda install -c conda-forge -c bioconda checkv
  • Using pip:
pip install checkv

If you decide to install CheckV via pip, make sure you also have the following external dependencies installed:

  • BLAST+ (v2.5.0)
  • DIAMOND (v0.9.30)
  • HMMER (v3.3)
  • Prodigal (v2.6.3)

The versions listed above were the ones that were properly tested. Different versions may also work.

CheckV database

Whichever method you choose to install CheckV you will need to download and extract database in order to use it:

wget https://www.dropbox.com/s/xz8h7d1ycrf4fjf/checkv-db-v0.4.tar.gz
tar -zxvf checkv-db-v0.4.tar.gz

Update your environment:

export CHECKVDB=/path/to/checkv-db-v0.4

If you don't want to set the environmet variable, you can still use the database through the -d parameter of the contamination and completeness modules.

Quick start

Navigate to CheckV test directory:

cd /path/to/checkv/test

Identify flanking host regions on integrated prophages:

checkv contamination test.fna checkv_out -t 16

Estimate completeness for genome fragments:

checkv completeness test.fna checkv_out -t 16

Identify (possible) complete genomes with terminal repeats:

checkv terminal_repeats test.fna checkv_out

Summarize CheckV output & classify contigs into quality tiers:

checkv quality_summary test.fna checkv_out

Project details


Download files

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

Source Distribution

checkv-0.2.0.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

checkv-0.2.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: checkv-0.2.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for checkv-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9a15c0ed6346038ec778001ec7e06cddb7ec75507d6031401eb19da2a5433b4b
MD5 3d0945eeeec3070fff742664ac919b1f
BLAKE2b-256 71b373653852feb6f21a722f304940f6964cc24adaa68d978e6effcf7c6d646f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: checkv-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for checkv-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9039f2b2d9895abaa8e5a5fb24f240dc9715ea5806138632e6c3da5163cc32f5
MD5 1672c63205cf36c50daf28cbcda10cb8
BLAKE2b-256 dbc29307e9d3f44342ccb8bf052bd07154c60d38f2074ad8e2a2ec61dcc087e7

See more details on using hashes here.

Supported by

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