Git Product home page Git Product logo

scara's Introduction

Scaffolding with ScaRa

ScaRa is our scaffolding tool that uses come concepts from the HERA scaffolder paper (https://www.biorxiv.org/content/early/2018/06/13/345983). This repository contains both Python and C++ implementations.

Installation

  1. Clone the repository, and include all submodules.
git clone --recursive https://github.com/kkrizanovic/ScaRa.git

Note: if you omitted <--recursive> from <git clone>, run <git submodule update --init --recursive> before proceeding.

After cloning, Python scripts are ready to go.

  1. Building C++ version
mkdir build
cd build
cmake ..
make

Dependencies

Python scripts require PYthon2.7. C++ version requires CMake 3.5.

Running Python version

ScaRa is run using <bridger.py> script from the root folder of the repository. Running the script without arguments will print out a help message. The script should be run wtith the first parameter set to scaffold in the following way:

bridger.py scaffold <contigs FASTA> <reads FASTA> <reads-contigs overlaps PAF/SAM> <reads-reads overlaps PAF/SAM options
options:"
-o (--output) <file> : output file to which the report will be written

Running C++ version

C++ executable should be in the build folder. Running it without arguments will print out following help message.

How to run ScaRa :
ScaRa -f (--folder) <Input folder>
    or
ScaRa -r <Reads file> -c <Contigs file> -o <Reads to Contigs Overlaps file> -s <Reads to Reds Overlaps file>
    The program will perform one iteration of the algorithm
    and output contigs to the standard output!.
    <Input foder> must contain the following files:
    - reads.fastq - reads in FASTQ/FASTA format
    - readsToContigs.paf - overlaps between reads and contigs
    - readsToReads.paf - overlaps between reads
    - contigs.fasta - contigs in FASTA format
If Reads file, Contigs file or Overlaps are specified,
they will not be looked for in the Input folder!
Options:
-f (--folder)     specify input folder for ScaRa
-r (--reads)      specify reads file for ScaRa
-c (--contigs)    specify contigs file ScaRa
-o (--overlapsRC)   specify contig-read overlaps file for ScaRa
-s (--overlapsRR)   specify read self overlaps file for ScaRa
-m (--multithreading)   use multithreading
-v (--version)    print program version
-h (--help)       print this help message

OLD ScaRa

Old ScaRa README (containing only the Python version) can be found at OLD ScaRa

scara's People

Contributors

kkrizanovic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

pythseq

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.