Code Monkey home page Code Monkey logo

arcs's Introduction

ARCS

Scaffolding genome sequence assemblies using 10X Genomics GemCode/Chromium data.

Dependencies

  • Boost (tested on 1.61)
  • GCC (tested on 4.4.7)
  • Autotools (if cloning directly from repository)
  • LINKS (tested on 1.8)

Compilation:

If cloning directly from the repository run:

./autogen.sh

To compile ARCS run:

./configure && make

To install ARCS in a specified directory:

./configure --prefix=/ARCS/PATH && make install

If your boost library headers are not in your PATH you can specify their location:

./configure โ€“-with-boost=/boost/path --prefix=/ARCS/PATH && make install

ARCS+LINKS Pipeline

There are three steps to the pipeline:

  1. Run ARCS to generate a Graphviz Dot file (.gv). Nodes in the graph are the sequences to scaffold, and edges show that there is evidence to suggest nodes are linked based on the data obtained from the GemCode/Chromium reads.

  2. Run the python script Examples/makeTSVfile.py to generate a file named XXX.tigpair_checkpoint file from the ARCS graph file. The XXX.tigpair_checkpoint file will be provided to LINKS in step 3.

  3. Run LINKS with the XXX.tigpair_checkpoint file as input. To do this, the base name (-b) must be set to the same name as XXX.

An example bash script on how to run the ARCS+LINKS pipeline can be found at: Examples/pipeline_example.sh

you can test your installation by following instructions at: Examples/arcs_test-demo/README.txt and compare your output to the files provided at: Examples/arcs_test-demo/output/

Citing ARCS

Paper : https://doi.org/10.1101/100750

LINKS : http://www.bcgsc.ca/platform/bioinfo/software/links https://github.com/warrenlr/LINKS

License

ARCS Copyright (c) 2016 British Columbia Cancer Agency Branch. All rights reserved.

ARCS is released under the GNU General Public License v3

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

For commercial licensing options, please contact Patrick Rebstein [email protected]

arcs's People

Contributors

sarahyeo avatar sjackman avatar justinchu avatar warrenlr avatar jvhaarst avatar

Watchers

James Cloos avatar answer_looker 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.