NP-SMLR is a software for GpC methylation detection and nucleosome occupancy inference at single-molecule level. It takes the aligned signal-levels from Oxford Nanopore sequencing reads, and outputs the posterior probability of methylation on every GpC site together with the positions of all inferred nuclosomes on each molecule.
The current version has been tested in the Linux system with:
- GCC (version 7.3.0);
- Perl (version 5.16.3);
- SAMtools (version 1.9);
- BEDtools (version 2.28.0).
You can download and compile the latest version (v1.0) as follows:
git clone https://github.com/Au-Lab/NP-SMLR.git
cd NP-SMLR
make
chmod +x NP-SMLR.pl
After compilation, three executable files (Likelihood, Detection and NclsPos) will be generated in the folder NP-SMLR/bin.
Please ensure that you have added
- The folder
NP-SMLR/bin SAMtoolsBEDtools
to your PATH.
Before running NP-SMLR,
- the reads have be aligned to reference genome; and
- the alignments between event signals and reference genome should be obtained using
nanopolish eventalign. Please make sure that the flag --print-names is set.
The tutorial of nanopolish eventalign can be found at https://nanopolish.readthedocs.io/en/latest/quickstart_eventalign.html.
The command is
NP-SMLR.pl -b sorted_bam_file -e event_align_scale -o output_dir
- Parameters
-b Name of the BAM file that records the alignment of reads. The BAM file must be sorted. -g Event alignment file generated by "nanopolish eventalign" (with flag --scale-events). -t Name of output folder.
- Example
The test example can be run using the command
NP-SMLR.pl -b ./testdata/sort_test.bam -e ./testdata/eventalign_scale_test.txt -o output
The generated files are stored under output.
The file ncls_pos.bed in the output folder records the coordinates of nucleosomes detected on each molecule. The columns represent:
Column 1: Chromosome ID;
Column 2: Start position of nucleosome;
Column 3: End position of nucleosome;
Column 4: Name of molecule (read);
Column 5: Quality score of alignment (obtained from BAM file);
Column 6: Strand on which the read is aligned.
The file detection.txt in the output folder records the methylation score of every GpC site on each molecule, which is essentially the posterior probability of methylation. The columns represent:
Column 1: Chromosome ID;
Column 2: Position of GpC site;
Column 3: Nucleotide sequence covering the GpC site (the 6-mers on this sequence are involved in the detection of GpC methylation);
Column 4: Name of molecule (read);
Column 5: Log likelihood of event-level with respect to negative control;
Column 6: Log likelihood of event-level with respect to positive control;
Column 7: Methylation score of GpC site (the posterior probability of methylation).
The version of the current release is v1.0.
Please contact wanganqi18@gmail.com for any question.
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License
For details, please read NP-SMLR/License.
Yunhao Wang*, Anqi Wang*, Zujun Liu, Andrew L. Thurman, Linda S. Powers, Meng Zou, Yue Zhao, Adam Hefel, Yunyi Li, Joseph Zabner, Kin Fai Au. Single-molecule long-read sequencing reveals the chromatin basis of gene expression. Genome Research, 2019. doi: 10.1101/gr.251116.119 (*contributed equally)