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
- Python 3.10+
- Python modules:
- pandas
- numpy
- scipy
- sklearn
- matplotlib
- seaborn
- pysam
- minimap2
- samtools
- 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:
- Install conda
- Create a new conda environment:
conda create -n nanomd python=3.12 - Activate the environment:
conda activate nanomd - Install the required packages:
conda install -c bioconda minimap2 samtools bedtools - Install the required python packages:
pip install pandas numpy scipy sklearn matplotlib seaborn pysam - Clone the nanoMD repository:
git clone https://github.com/LegendZDY/nanoMD.git - 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:
Metadata
Release files for nanomd 0.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nanomd-0.5.5.tar.gz | 32.4 kB | Without provenance | Details for nanomd-0.5.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nanomd-0.5.5-py3-none-any.whl | Python 3 | none | any | Details for nanomd-0.5.5-py3-none-any.whl |
Total release size: 78.6 kB
Release files / nanomd-0.5.5.tar.gz
| Download URL | nanomd-0.5.5.tar.gz |
|---|---|
| Size | 32.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9c19554836a078d3e079e9ac2a607d317dc2a5e0735620e11b59fad929e40f79
|
|
BLAKE2b-256 checksum How to use checksums |
a648d56dd822eda808d36e253e652fe0bfe53e7b92e5356ae0205dcf76e5e512
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.3 CPython/3.12.8 Linux/5.15.0-185-generic
|
Release files / nanomd-0.5.5-py3-none-any.whl
| Download URL | nanomd-0.5.5-py3-none-any.whl |
|---|---|
| Size | 46.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2f388f18f6d81a16bbf7ccaf3d7fe7564e3187017a00f86ba39eb0c199f0fb3c
|
|
BLAKE2b-256 checksum How to use checksums |
5548db58dc6bf901d643b4349a5fe9f22651f96ac02e18030368f02dbe422b63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.3 CPython/3.12.8 Linux/5.15.0-185-generic
|
Security for nanomd 0.5.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.