Skip to main content

An accurate NGS-based structural variant detection tool for human genomes

Project description

SVhet

An accurate NGS-based structural variation filtering tool based on heterozygous sites on reads mapped to deleted regions and their flanks. SVhet has been tested on common SV callers including Manta, DELLY and Lumpy (both PE150 and PE250). While SVhet works for all regions in theory, it is only tested on GIAB v0.6 Tier 1 SV regions, with either/both breakpoint(s) located within the regions. To use SVhet with minimal loss in recall and best performance, users are recommended to include only SVs within Tier 1 regions and not specify --fully-within.

GIAB v0.6 Tier 1 SV benchmark regions can be downloaded here.

Installation

SVhet can be downloaded and installed using conda or mamba. This will automatically configure the environment and install most dependencies of SVhet.

git clone git@github.com:snakesch/SVhet.git
cd SVhet
conda env create -f environment.yml
conda activate svhet

Next, make sure singularity (v3.0+) is available on the system and pull the DeepVariant image:

singularity pull docker://google/deepvariant:1.9.0

Running SVhet

SVhet can be run as a single command from CLI and takes as input candidate SVs proposed by state-of-the-art SV callers (both VCF and BAM) and a reference genome. Depending on the specific SV caller used, users may adopt different CIPOS and CIEND tags (e.g. CIPOS95 for Lumpy).

svhet \
--input VCF \
--bam BAM \
--ref REFERENCE \
--output VCF_OUT \
--image DEEPVARIANT_IMAGE \
--outdir OUTPUT_DIR \
--threads INT \
--cipos-tag CIPOS \
--ciend-tag CIEND

A list of all available arguments can be accessed from svhet --help.

Test run

A minimal test set is available from test/. To run the test case, download hs37d5 reference and its index file from GIAB FTP

Test command:

svhet \
--input test.vcf.gz \
--bam test.bam \
--ref REFERENCE \
--output test.svhet.vcf.gz \
--image DEEPVARIANT_IMAGE \
--outdir test_output/ \
--threads 4 \
--cipos-tag CIPOS \
--ciend-tag CIEND

Upon successful execution, output files should be similar to those in test/test_output/.

License

SVhet is available under an MIT license.

Issues and correspondence

Issues and correspondence to Louis SHE (snakesch@connect.hku.hk).

Citation

Preprint pending.

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

svhet-0.1.0.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

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

svhet-0.1.0-py3-none-any.whl (60.1 kB view details)

Uploaded Python 3

File details

Details for the file svhet-0.1.0.tar.gz.

File metadata

  • Download URL: svhet-0.1.0.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for svhet-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b8c9bedc7c6936c7c07b150fedd605e5c299603950ec66eb306430123964129d
MD5 7bc6aa3d478356d864ce90024085fd64
BLAKE2b-256 3e5932fc807f4d3474c272be9f4e4fc75f06102ed249fd324a25ef7f85a5b745

See more details on using hashes here.

File details

Details for the file svhet-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: svhet-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 60.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for svhet-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac0dfc409919ac27752a4964b6529a4c6ea3c8d7fa48aafda234c5b79a063a48
MD5 806a1e76bfb009d1a16fd12b6c658f86
BLAKE2b-256 4dca05551e2ef576a4ae83f65d44e5147ea67396404d9b2750595a4f71da8b26

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