Skip to main content

cuteSV

PyPI version Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge


Getting Start

                                               __________    __       __
                                              |   ____   |  |  |     |  |
                          _                   |  |    |__|  |  |     |  |
 _______    _     _   ___| |___     ______    |  |          |  |     |  |
|  ___  |  | |   | | |___   ___|   / ____ \   |  |_______   |  |     |  |
| |   |_|  | |   | |     | |      / /____\ \  |_______   |  |  |     |  |
| |        | |   | |     | |      | _______|   __     |  |  \  \     /  /
| |    _   | |   | |     | |  _   | |     _   |  |    |  |   \  \   /  /
| |___| |  | |___| |     | |_| |  \ \____/ |  |  |____|  |    \  \_/  /
|_______|  |_______|     |_____|   \______/   |__________|     \_____/

Installation

$ pip install cuteSV
or
$ conda install -c bioconda cutesv
or 
$ git clone https://github.com/tjiangHIT/cuteSV.git && cd cuteSV/ && pip install .

Introduction

Long-read sequencing enables the comprehensive discovery of structural variations (SVs). However, it is still non-trivial to achieve high sensitivity and performance simultaneously due to the complex SV characteristics implied by noisy long reads. Therefore, we propose cuteSV, a sensitive, fast and scalable long-read-based SV detection approach. cuteSV uses tailored methods to collect the signatures of various types of SVs and employs a clustering-and-refinement method to analyze the signatures to implement sensitive SV detection. Benchmarks on real Pacific Biosciences (PacBio) and Oxford Nanopore Technology (ONT) datasets demonstrate that cuteSV has better yields and scalability than state-of-the-art tools.

The benchmark results of cuteSV on the HG002 human sample are below:

BTW, we used Truvari to calculate the recall, precision, and f-measure. For more detailed implementation of SV benchmarks, we show an example here.


Dependence

1. python3
2. pysam
3. Biopython
4. cigar
5. numpy

Usage

cuteSV <sorted.bam> <output.vcf> <work_dir>

Suggestions

> For PacBio CLR/ONT data:
	--max_cluster_bias_INS		100
	--diff_ratio_merging_INS	0.2
	--diff_ratio_filtering_INS	0.6
	--diff_ratio_filtering_DEL	0.7
> For PacBio CCS(HIFI) data:
	--max_cluster_bias_INS		200
	--diff_ratio_merging_INS	0.65
	--diff_ratio_filtering_INS	0.65
	--diff_ratio_filtering_DEL	0.35
Parameter Description Default
--threads Number of threads to use. 16
--batches Batch of genome segmentation interval. 10,000,000
--sample Sample name/id NULL
--max_split_parts Maximum number of split segments a read may be aligned before it is ignored. 7
--min_mapq Minimum mapping quality value of alignment to be taken into account. 20
--min_read_len Ignores reads that only report alignments with not longer than bp. 500
--merge_threshold Maximum distance of SV signals to be merged. 500
--min_support Minimum number of reads that support a SV to be reported. 10
--min_length Minimum length of SV to be reported. 30
--genotype Enable to generate genotypes. False
--hom Threshold on allele frequency for homozygous. 0.8
--het Threshold on allele frequency for heterozygous. 0.2
--max_cluster_bias_INS Maximum distance to cluster read together for insertion. 100
--diff_ratio_merging_INS Do not merge breakpoints with basepair identity more than the ratio of default for insertion. 0.2
--diff_ratio_filtering_INS Filter breakpoints with basepair identity less than the ratio of default for insertion. 0.6
--max_cluster_bias_DEL Maximum distance to cluster read together for deletion. 200
--diff_ratio_merging_DEL Do not merge breakpoints with basepair identity more than the ratio of default for deletion. 0.3
--diff_ratio_filtering_DEL Filter breakpoints with basepair identity less than the ratio of default for deletion. 0.7
--max_cluster_bias_INV Maximum distance to cluster read together for inversion. 500
--max_cluster_bias_DUP Maximum distance to cluster read together for duplication. 500
--max_cluster_bias_TRA Maximum distance to cluster read together for translocation. 50
--diff_ratio_filtering_TRA Filter breakpoints with basepair identity less than the ratio of default for translocation. 0.6

Datasets generated from cuteSV

We provided the SV callsets of the HG002 human sample produced by cuteSV form three different long-read sequencing platforms (i.e. PacBio CLR, PacBio CCS, and ONT PromethION).

You can download them at: DOI

Please cite the manuscript of cuteSV before using these callsets.


Changelog

cuteSV (v1.0.4):
1.Add a new option for specificly setting the threshold of SV signals merging in the same read. The default parameter is 500 bp. You can reduce it for high-quality sequencing datasets like PacBio HiFi (CCS).
2.Make the genotyping function optional.
3.Enable users to set the threshold of SV allele frequency of homozygous/heterozygous.
4.Update the description of recommendation parameters in processing ONT data.

cuteSV (v1.0.3):
1.Refine the genotyping model.
2.Adjust the threshold value of heterozygosis alleles.

cuteSV (v1.0.2):
1.Improve the genotyping performance and enable it to be default option.
2.Make the description of parameters better.
3.Modify the header description of vcf file.
4.Add two new indicators, i.e., BREAKPOINT_STD and SVLEN_STD, to further characterise deletion and insertion.
5.Remove a few redundant functions which will reduce code readability.

Citation

Long Read based Human Genomic Structural Variation Detection with cuteSV. Tao Jiang, et al. bioRxiv 780700; doi: https://doi.org/10.1101/780700


Contact

For advising, bug reporting and requiring help, please post on Github Issue or contact tjiang@hit.edu.cn.

Download files

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

Source Distribution

cuteSV-1.0.4.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

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

cuteSV-1.0.4-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

Details for the file cuteSV-1.0.4.tar.gz.

File metadata

  • Download URL: cuteSV-1.0.4.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191101 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for cuteSV-1.0.4.tar.gz
Algorithm Hash digest
SHA256 5caceba45e7bd57336e16f0bdfcec204d33512c99bd06e7a9a73ebcdd585286f
MD5 994c79510d130db62e26e4c46eec2e47
BLAKE2b-256 97a0a1a3b5893bd7688f1c13a8edc6725bf777c49e300eb1b94b140a574f01e8

See more details on using hashes here.

File details

Details for the file cuteSV-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: cuteSV-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 31.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191101 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for cuteSV-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1cd39655e201a7f879299081f29b943fe370962381934859e41b5fff9aed85c7
MD5 07cf745929208764fb6b1035080764f9
BLAKE2b-256 53fd06a267ba82f3887fa6992b90468d2a7445f8d868207655c690b772b10c20

See more details on using hashes here.

Release history Release notifications | RSS feed

2.1.4

1 file

2.1.3

1 file

2.1.2

1 file

2.1.1

1 file

2.1.0

1 file

2.0.3

1 file

2.0.2

2 files

2.0.1

1 file

2.0.0

2 files

1.0.13

3 files

1.0.12

2 files

1.0.11

3 files

1.0.10

3 files

1.0.9

3 files

1.0.7

3 files

1.0.6

2 files

1.0.5

2 files

This release

1.0.4 This release

2 files

1.0.3

2 files

1.0.2.1

1 file

1.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page