Skip to main content

Tools to deal with one or more measurements from single cells

Project description

Documentation Status PyPI version DOI

Single cell multi omics

Single cell multi omics is a set of tools to deal with multiple measurements from the same cell. This package is maintained by Barbanson Biotech.

Installation

pip install singlecellmultiomics

For creating a virtual environment look here

Usage

demux.py: This tool demultiplexes raw fastq files, adapters, molecule and cell information are removed from the fastq records and encoded into the read name including their base-calling qualities. Additional stored inforation includes:

  • Assigned and raw illumina index
  • Library
  • Demultiplexing strategy used for demultiplexing (What kind of data the read is derived from)
  • Assigned barcode index

The next step is usually to trim and then map the demultiplexed reads.

For RNA seq data aligned to a transcriptome the step after this is to run featureCounts.

The mapped reads are encoded in a BAM file. This BAM file still contains the encoded data and this has to be decoded in order to get a useful BAM file. bamtagmultiome.py

  1. Recodes the original read names and extracts all information previously encoded by the demultiplexer.

  2. Adds allele information. (A VCF file is required for this)

  3. Supports multiple protocols: RNA:CELSEQ1, CELSEQ2, VASA (with 8 and 6bp UMI), methylation digest sequencing:SC MSPJI ,
    lineage tracing:SCARTRACE, DNA digest sequencing: NLAIII, Epigenetic modification sequencing: scCHIC, scCHIC+Transcriptome, DamID, DamID+T Single cell methylation : TAPs (in combination with any other supported protocol).

  4. Assigns reads to molecules to allow for deduplication, adds duplication BAM flag

  5. Assigns read groups

  6. Splits libraries where multiple modalities are measured

  7. Estimates consensus sequences of molecules

All SAM tags used and written by this package are listed in TAGS.MD

bamToCountTable.py Extracts a count table from a bam file, look here for examples.

libraryStatistics.py All statistics plots can be generated with a single script, look here for details.

Examples:

Demultiplex all fastq.gz files in the current directory using NLAIII barcodes

demux.py *.fastq.gz -use NLAIII384C8U3 --y

Demultiplex only the specified sequencing index (GTTTGA), and everything 1 hamming distance away from GTTTGA :

demux.py -si GTTTGA *.gz --y --hdi 1

API: Using SingleCellMultiOmics from python

All molecule and fragment information can be accessed using python Documentation for the classes in available here

scCHIC

For every fragment in input.bam find scCHIC seq fragments and deduplicate these. Fragments with the same cell barcode, umi, library and strand and starting within a range of 5 bp from each other are assigned as duplicate. The mnase cut site location is expected to be between the first base (Usually an A) this A is part of the sequencing adapter, and the second base (Usually a T). The cut site location is recorded into the DS tag. When alleles are specified using -alleles, the molecule assignment is split up by allele, this means that if two fragments map to the same location and share the same umi, but contain SNPs which indicate differing alleles, the reads are not assigned to the same molecule. For every fragment the ligation sequence is recorded into the RZ tag.

bamtagmultiome.py input.bam -method chic -o tagged.bam

Complete scCHIC data processing instructions from FastQ to count table here

NlaIII

For every fragment in input.bam find NLAIII seq fragments and deduplicate these. Fragments with the same cell barcode, umi, library and strand are assigned as duplicate. The NlaIII cut site location is recorded into the DS tag. When alleles are specified using -alleles, the molecule assignment is split up by allele, this means that if two fragments map to the same location and share the same UMI, but contain SNPs which indicate differing alleles, the reads are not assigned to the same molecule. For every fragment the sequenced part of the NlaIII cut site sequence is recorded into the RZ tag, this is usually CATG, but is allowed to be shifted 1 base to ATG. In the NlaIII protocol a reverse transcription (RT) is used, generally capturing more reverse transcription reactions will yield a more accurate molecule consensus sequence. For every fragment which support the molecule the reverse transcription reaction is recorded by storing the location of the random primer used for RT and the sequence of the random primer.

bamtagmultiome.py input.bam -method nla -o tagged.bam

Complete NlaIII data processing instructions from FastQ to count table here

Plate visualisation

Show relative abundance of reads and unique molecules across 384 well plate.

bamPlateVisualisation.py tagged.bam -o ./plate_plots

Creates the folder ./plate_plots containing

raw_reads_[LIBRARY_TYPE]_[LIBRARY_NAME].png # Distribution of total reads
usable_reads_[LIBRARY_TYPE]_[LIBRARY_NAME].png # Distribution of reads which can be assigned to a molecule
unique_reads_[LIBRARY_TYPE]_[LIBRARY_NAME].png # Distribution of unique reads

All statistics plots can be generated with a single script, look here for details.

Create a contig by sample matrix and divide counts when reads are multimapping. (Used for counting transcriptome mapped reads)

bamToCountTable.py -featureTags chrom -sampleTags SM --divideMultimapping --dedup ./tagged/STAR_mappedAligned.sortedByCoord.out.bam -o transcriptome_counts.csv

Obtain sample, chromosome, restrictionsite, read start, and read end from test.bam file:

bamTabulator.py -featureTags SM,reference_name,DS,reference_start,reference_end test.bam

List all available tags:

bamTabulator.py test.bam

You can additionaly use any of the pysam read attributes

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

singlecellmultiomics-0.1.44.tar.gz (19.9 MB view details)

Uploaded Source

Built Distribution

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

singlecellmultiomics-0.1.44-py3-none-any.whl (20.2 MB view details)

Uploaded Python 3

File details

Details for the file singlecellmultiomics-0.1.44.tar.gz.

File metadata

  • Download URL: singlecellmultiomics-0.1.44.tar.gz
  • Upload date:
  • Size: 19.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for singlecellmultiomics-0.1.44.tar.gz
Algorithm Hash digest
SHA256 7b2d10284dccd5d6b653ee6bfbe8792c27c1aa49ba81a7fb07e146b7511d12e1
MD5 66fb2cb803b2addfee03d9b7e6830103
BLAKE2b-256 713372e2087e1b0c5c1c447cb9ec39394f121df1192cadb64bfd7214361cd852

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellmultiomics-0.1.44.tar.gz:

Publisher: pythonpublish.yml on BuysDB/SingleCellMultiOmics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file singlecellmultiomics-0.1.44-py3-none-any.whl.

File metadata

File hashes

Hashes for singlecellmultiomics-0.1.44-py3-none-any.whl
Algorithm Hash digest
SHA256 119077f92322fa35fd173880fe89674ba1cfd28ed653fa0f2f4963bbb868e0c4
MD5 ad49e934da07b8897c9f0d54a005c3c5
BLAKE2b-256 cc30309789484701b4d2d9aafc9c48a160c7e1850c7e5aea9d511896377f6dd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellmultiomics-0.1.44-py3-none-any.whl:

Publisher: pythonpublish.yml on BuysDB/SingleCellMultiOmics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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