Skip to main content

An HPV integration sites detection tool for targeted capture sequencing data

Project description

Documentation Status License PyPI version

Host Downloads
PyPI Downloads

SearcHPV

An HPV integration point detection tool for targeted capture sequencing data

Introdution

  • SearcHPV detects HPV fusion sites on both human genome and HPV genome
  • SearcHPV is able to provide locally assembled contigs for each integration events. It will report at least one and at most two contigs for each integration sites. The two contigs will provide information captured for left and right sides of the event.

Getting started

  1. Required resources
  • Unix like environment
  • Third-party tools:
Python/3.7.3 https://www.python.org/downloads/release/python-373/
samtools/1.5 https://github.com/samtools/samtools/releases/tag/1.5
BWA/0.7.15-r1140 https://github.com/lh3/bwa/releases/tag/v0.7.15
java/1.8.0_252 https://www.oracle.com/java/technologies/javase/8all-relnotes.html
Picard Tools/2.23.8 https://github.com/broadinstitute/picard/releases/tag/2.23.8
PEAR/0.9.2 https://github.com/tseemann/PEAR
CAP3/02/10/15 http://seq.cs.iastate.edu/cap3.html

After intalling these tools, please make sure that their path have been added to you ".bashrc" script so that you can use them by typing the tool names in the terminal.

  1. Download and install Firstly, download and install the required resources. Then, tap these commands in your terminal:
pip install searcHPV

  1. Usage SearcHPV have four main steps. You could either run it start-to-finish or run it step-by-step.
  • Usage:
searcHPV <options> ...
  • Standard options:
 -fastq1 <str>  sequencing data: fastq/fq.gz file
 -fastq2 <str>  sequencing data: fastq/fq.gz file
 -humRef <str>  human reference genome: fasta file
 -virRef <str>  HPV reference genome: fasta file
  • Optional options:
-h, --help      show this help message and exit
-window <int>   the length of region searching for informative reads, default=300
-output <str>   output directory, default "./"
-alignment      run the alignment step, step1
-genomeFusion   call the genome fusion points, step2
-assemble local assemble for each integration event, step3
-hpvFusion call the HPV fusion points, step4

  • Examples:
  1. Run it start-to-finish:
searcHPV -fastq1 Sample_81279.R1.fastq.gz -fastq2 Sample_81279.R2.fastq.gz -humRef hs37d5.fa -virRef HPV.fa -output /home/scratch/HPV_fusion/Sample_81279

  1. Run it step-by-step:
searchHPV -align -fastq1 Sample_81279.R1.fastq.gz -fastq2 Sample_81279.R2.fastq.gz -humRef hs37d5.fa -virRef HPV.fa -output /home/scratch/HPV_fusion/Sample_81279
searchHPV -genomeFusion -fastq1 Sample_81279.R1.fastq.gz -fastq2 Sample_81279.R2.fastq.gz -humRef hs37d5.fa -virRef HPV.fa -output /home/scratch/HPV_fusion/Sample_81279
searchHPV -assemble -fastq1 Sample_81279.R1.fastq.gz -fastq2 Sample_81279.R2.fastq.gz -humRef hs37d5.fa -virRef HPV.fa -output /home/scratch/HPV_fusion/Sample_81279
searchHPV -hpvFusion -fastq1 Sample_81279.R1.fastq.gz -fastq2 Sample_81279.R2.fastq.gz -humRef hs37d5.fa -virRef HPV.fa -output /home/scratch/HPV_fusion/Sample_81279

Note: if run it step-by-step, please make sure the output directories for all steps are the same.

Output

  1. Alignment: the marked dupliaction alignment bam file and customized reference genome.\
  2. Genome Fusion Point Calling: orignal callset, filtered callset, filtered clustered callset.\
  3. Assemble: supportive reads, contigs for each integration events (unfiltered).\
  4. HPV fusion Point Calling: alignment bam file for contigs againt human and HPV genome.\ Final outputs are under the folder "call_fusion_virus": summary of all the integration events : "HPVfusionPointContig.txt" contig sequences for all the integration events: "ContigsSequence.fa"

Citation

SearcHPV: a novel approach to identify and assemble human papillomavirus-host genomic integration events in cancer --- Accepted by Cancer

Contact

wenjingu@umich.edu

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

searcHPV-1.0.5.tar.gz (22.0 kB view details)

Uploaded Source

Built Distributions

searcHPV-1.0.5-py3.8.egg (40.8 kB view details)

Uploaded Source

searcHPV-1.0.5-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file searcHPV-1.0.5.tar.gz.

File metadata

  • Download URL: searcHPV-1.0.5.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for searcHPV-1.0.5.tar.gz
Algorithm Hash digest
SHA256 fbb125de05d6173329436b46a83b887964181eb7795820680f7e7b141a754aaa
MD5 393f27efe1d1fb0d0d8c179b4dc10b6b
BLAKE2b-256 6b2ec1cf8723d6df8dc5d80115272367bfc7d99f4beecc9dd636ac1b87c04525

See more details on using hashes here.

Provenance

File details

Details for the file searcHPV-1.0.5-py3.8.egg.

File metadata

  • Download URL: searcHPV-1.0.5-py3.8.egg
  • Upload date:
  • Size: 40.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for searcHPV-1.0.5-py3.8.egg
Algorithm Hash digest
SHA256 5021855e0b93aa7ca9c3bc9ef1117b385c04dd42cd49e29de235de004b6eefec
MD5 6335e4568a4050227b544d1253e0b504
BLAKE2b-256 56fc6ef84e9dc6a2082a276eb799d76f6dac97dd7510b024af157567c5192961

See more details on using hashes here.

Provenance

File details

Details for the file searcHPV-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: searcHPV-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for searcHPV-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 69b9d0da006d354880d4f8505d2a4ff18c33ae8aad22106f5e266036a3f86bce
MD5 87bd8fcab2d0ad1119ffe613f89c5adf
BLAKE2b-256 beca4d1f5a1ba3694e223e7a94c2f304cb723dfd309e57974bfe96c10e05c871

See more details on using hashes here.

Provenance

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