Skip to main content

Locally reassembling haplotypes from BAM files generated by WGS data.

Project description

Local Reassembly

Local Reassembly is a tool for locally reassembling reads from a mapped BAM file. We have two modes of operation: "assembly" and "haplotype". In "assembly" mode, we use SPAdes to perform de novo assembly of the mapped reads. In "haplotype" mode, we use whatshap to perform haplotype assembly of the mapped reads. The output is a FASTA file containing the assembled contigs.

Installation

Local Reassembly is a Python package that can be installed using pip. To install the package, run the following command:

pip install local_reassembly

We also recommend installing with Docker, please see Dockerfile for more information.

Usage

  • Assembly
usage: locasm reassm [-h] [-o OUTPUT_PREFIX] [-t TMP_WORK_DIR] [-d] [-m {assembly,haplotype}] input_genome_file input_bam_file region

Local reassembly

positional arguments:
  input_genome_file     input genome file in FASTA format
  input_bam_file        input BAM file
  region                genomic region in the format chr:start-end

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_PREFIX, --output_prefix OUTPUT_PREFIX
                        output prefix for the reassembly files
  -t TMP_WORK_DIR, --tmp_work_dir TMP_WORK_DIR
                        temporary working directory, default is current directory
  -d, --debug           debug mode, default False
  -m {assembly,haplotype}, --mode {assembly,haplotype}
                        mode of operation: "assembly" for local assembly, "haplotype" for haplotype reconstruction
  • Annotation
usage: locasm reanno [-h] [-o OUTPUT_PREFIX] [-t TMP_WORK_DIR] [-d] local_assem_fasta ref_pt_fasta ref_cDNA_fasta

Local reannotation

positional arguments:
  local_assem_fasta     local assembly FASTA file
  ref_pt_fasta          reference point FASTA file
  ref_cDNA_fasta        reference cDNA FASTA file

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_PREFIX, --output_prefix OUTPUT_PREFIX
                        output prefix for the reannotation files
  -t TMP_WORK_DIR, --tmp_work_dir TMP_WORK_DIR
                        temporary working directory, default is current directory
  -d, --debug           debug mode, default False

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

local_reassembly-0.0.2.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

local_reassembly-0.0.2-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file local_reassembly-0.0.2.tar.gz.

File metadata

  • Download URL: local_reassembly-0.0.2.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for local_reassembly-0.0.2.tar.gz
Algorithm Hash digest
SHA256 77c34c83651567c86c4dca2c22b195dec7f8f42c7c1853303318e7492dc55f87
MD5 6987c933f5c34fcb30c23440e8e0bea0
BLAKE2b-256 2fc647f9e66cabf6fcd49f21e77390ce174550e31454fc6dd8ab0631b1bd12c4

See more details on using hashes here.

File details

Details for the file local_reassembly-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for local_reassembly-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 235558599a48eb8c7bbebf5bf3f7d625edf3f8011bd05b666d773c805f1fbdce
MD5 e50bd0a7cd4db4889c3a31dddd3542f7
BLAKE2b-256 0bfd9f1020828da8686a097e94b6482cb6d94ae7f24141d7d801ed19c557732e

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