Skip to main content

nanoMD

Overview

nanoMD is designed to work with the output of the ONT direct RNA sequencing platform and can be used to identify new m6A sites, genes, and isoforms, as well as detect and quantify new mRNA.

It is recommended to use the docker or conda environment to run the pipeline.

Requirements

  1. Python 3.10+
  2. Python modules:
    • pandas
    • numpy
    • scipy
    • sklearn
    • matplotlib
    • seaborn
    • pysam
  3. minimap2
  4. samtools
  5. bedtools

nanoMD modules

nanomd.py is the main module of nanoMD, which includes the following sub-modules:

  • gene
  • count
  • polyA
  • matrix
  • detectMod
  • nascentRNA

nanomd gene

Usage

nanomd gene -i ../input/{}/pass.fq.gz -r ../reference/fasta/genome.fa -o ./{}_gene.sam --parms '--secondary=no --cs -a --sam-hit-only'

nanomd count

Usage

nanomd count -i ../input/{}/pass.fq.gz -r ../reference/fasta/transcripts.fa -p {}

nanomd polyA

Usage

nanomd polyA -i ./pass.fq.gz --transcriptome=$ref -o . -p Ctrl-1

nanomd matrix

Usage

nanomd matrix -i "*_polyA.tsv" -c "WT1_polyA.tsv,WT2_polyA.tsv" -p polyA -s human -t polyA --docker

nanomd matrix -i "*_quant" -c "NC1_quant,NC2_quant,NC3_quant,NC4_quant,NC5_quant" -p salmon -s human --docker

nanomd detectMod

Usage

nanomd detectMod -i ../input/{}/pass.fq.gz -s ../01_map_gene/{}_gene.sam -b ../reference/genes/genes.bed -r ../reference/genes/region_sizes.txt -p {}

nanomd nascentRNA

Usage

nanomd nascentRNA -i ../input/{}/pass.fq.gz -s ../01_map_gene/{}_gene.sam -r ../reference/fasta/transcripts.fa -m ~/soft/newRNA.pkl -p {}

Scripts

We provide a set of standalone scripts for 5EU detection and quantification.

detect5EU.py

This script detects 5' untranslated regions (5EU) from the ONT direct RNA sequencing data.

Usage

python detect5EU.py -i sample.fastq -o 5EU.bed

Docker

If the user has docker installed, the following command can be used to run the pipeline in a docker container:

docker run -v /path/to/data:/data -it nanomd/nanomd:latest /bin/bash

Conda Environment

If the user has conda installed, the following command can be used to create a conda environment for nanoMD:

  1. Install conda
  2. Create a new conda environment: conda create -n nanomd python=3.12
  3. Activate the environment: conda activate nanomd
  4. Install the required packages: conda install -c bioconda minimap2 samtools bedtools
  5. Install the required python packages: pip install pandas numpy scipy sklearn matplotlib seaborn pysam
  6. Clone the nanoMD repository: git clone https://github.com/LegendZDY/nanoMD.git
  7. Run the pipeline: nanomd gene -i ../input/{}/pass.fq.gz -r ../reference/fasta/genome.fa -o ./{}_gene.sam --parms '--secondary=no --cs -a --sam-hit-only'

Cite nanoMD

If you use nanoMD in your research, please cite the following paper:

Download files

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

Source Distribution

nanomd-0.5.5.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

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

nanomd-0.5.5-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

Details for the file nanomd-0.5.5.tar.gz.

File metadata

  • Download URL: nanomd-0.5.5.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.3 CPython/3.12.8 Linux/5.15.0-185-generic

File hashes

Hashes for nanomd-0.5.5.tar.gz
Algorithm Hash digest
SHA256 9c19554836a078d3e079e9ac2a607d317dc2a5e0735620e11b59fad929e40f79
MD5 a0491bf7dd03812b5dfb1c90dd23a718
BLAKE2b-256 a648d56dd822eda808d36e253e652fe0bfe53e7b92e5356ae0205dcf76e5e512

See more details on using hashes here.

File details

Details for the file nanomd-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: nanomd-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 46.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.3 CPython/3.12.8 Linux/5.15.0-185-generic

File hashes

Hashes for nanomd-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2f388f18f6d81a16bbf7ccaf3d7fe7564e3187017a00f86ba39eb0c199f0fb3c
MD5 6bc4ce3115afdeb6912ec03c4879171e
BLAKE2b-256 5548db58dc6bf901d643b4349a5fe9f22651f96ac02e18030368f02dbe422b63

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.5.5 This release

2 files

0.5.4

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.9

2 files

0.3.8

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.1.0

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