Skip to content

De novo clustering of long transcript reads into genes

License

Notifications You must be signed in to change notification settings

aljpetri/isONclust3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

isONclust3

A rust implementation of a novel de novo clustering algorithm. isONclust3 is a tool for clustering either PacBio Iso-Seq reads, or Oxford Nanopore reads into clusters, where each cluster represents all reads that came from a gene family. Output is a tsv file with each read assigned to a cluster-ID and a folder 'fastq' containing one fastq file per cluster generated. Detailed information is available in paper.

Table of contents

  1. Installation
  2. Introduction
  3. Output
  4. Running isONform
    1. Running a test
  5. Contact
  6. Credits

Installation Guide

At the moment building from source is the only option to install the tool. This requires users to install the Rust programming language onto their system.

Installing Rust

You can install rust via

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh (for macOS and Linux or other Unix-based OS). For Windows please follow the instructions on the following site: https://forge.rust-lang.org/infra/other-installation-methods.html .

Installation

After cloning the repository via git clone https://github.com/aljpetri/isONclust3.git use the following two commands to compile the code:
cd isONclust3
cargo build --release ( Compile the current package, the executable is then located in target/release)

Introduction

Running isONclust3

To run the algorithm:

Contact

If you encounter any problems, please raise an issue on the issues page, you can also contact the developer of this repository via: alexander.petri[at]math.su.se

Credits