Code Monkey home page Code Monkey logo

modena's Introduction

modena

Modena is a nanopore-based computational method for detecting a wide spectrum of epigenetic and epitranscriptomic modifications.

It uses an unsupervised learning approach, namely resampling of nanopore signals followed by the Kuiper test. Unlike other unsupervised tools, classification is performed by 1D clustering of scores into two groups.

Important

This version of Modena is v2 beta. To find the stable v1 version of Modena, visit the v1.0.0 git tag.

setup

To install and use Modena, you need at least Python 3.10 and the Poetry package manager. Then run the following commands:

$ git clone https://github.com/sbidin/modena.git
$ cd modena
$ poetry install
$ poetry run python -m modena --help # See options.
$ poetry --directory path/to/modena/dir/ run python -m modena # Run outside modena dir.

inputs

Both datasets need to be supplied in blow5 or slow5 format, alongside their f5c resquiggle output tsv files. If your dataset is in single/multi fast5 format, or pod5 format, you can apply conversions using one of the following tools:

To resquiggle your data with f5c, install f5c and run the resquiggle command:

$ f5c resquiggle data.fastq data.blow5 > resquiggled.tsv

example modena usage

Both datasets (in this case a and b) need a blow5 or slow5 file and a corresponding f5c-resquiggled tsv file.

$ poetry run python -m modena -a a.blow5 -ax a.tsv -b b.blow5 -bx b.tsv -o out.tsv
$ poetry run python -m modena --help # See here for more options.

output format

Modena outputs a simple tsv file with four columns:

  • position, int, 1-based
  • coverage, int, a count of all reads that contributed to the signal
  • distance, float, a two-sample Kuiper-test-based measure (a distance sum)
  • label, str, "pos" or "neg", separating positions into two clusters

modena's People

Contributors

sbidin avatar

Stargazers

Vladimir Uzun avatar  avatar Josip avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.