MBoemo / DNAscent

Software for detecting regions of BrdU and EdU incorporation in Oxford Nanopore reads.
https://www.boemogroup.org/
GNU General Public License v3.0
26 stars 13 forks source link

DNAscent

Documentation Status

DNAscent is software designed to detect the base analogues BrdU and EdU in single molecules of DNA sequenced on the Oxford Nanopore platform. In an experimental setup where BrdU and EdU are incorporated into nascent DNA by replication forks, this software can be used to answer questions that were traditionally answered by DNA fibre analysis. DNAscent can also call the genomic positions of stalled and stressed replication forks for use as a replication stress assay.

DNAscent v4.0.3 supports sequencing data collected on Oxford Nanopore R10.4.1 flow cells. The Oxford Nanopore Flongle, MinION, GridION, and PromethION platforms are all supported.

DNAscent is under active development by the Boemo Group based in the Department of Pathology, University of Cambridge.

Singularity Image

The recommended way to run DNAscent is via one of our supported Singularity images: https://cloud.sylabs.io/library/mboemo/dnascent/dnascent You can obtain the latest image by running:

singularity pull DNAscent.sif library://mboemo/dnascent/dnascent:4.0.3

Building from Source

Clone the DNAscent repository with the recursive flag so that the dependencies are cloned as well.

git clone --recursive https://github.com/MBoemo/DNAscent.git

The DNAscent directory will appear in your current directory. Switch to the latest tagged version and compile the software by running:

cd DNAscent
git checkout 4.0.3
make

This will put the DNAscent executable into the DNAscent/bin directory. A typical compile time for DNAscent and its dependencies is 5 minutes.

Documentation

Please see the documentation for detailed usage instructions, descriptions of DNAscent's subprograms, and an example workflow.

Citation

Please cite our publications if you use DNAscent for your research:

Questions and Bugs

Should any bugs arise or if you have basic usage questions, please raise a GitHub issue. For more detailed discussions or collaborations, please Email Michael Boemo at mb915@cam.ac.uk.

Legacy Flow Cells

Users wishing to analyse data acquired on legacy R9.4.1 flow cells should roll back to DNAscent v3.1.2 as v4.0.1 and above are not back-compatible with R9.4.1 flow cells. As R9.4.1 flow cells have been deprecated by Oxford Nanopore, previous versions of DNAscent designed for R9.4.1 flow cells (v3.1.2 and below) are no longer under active development.