Giter Club home page Giter Club logo

docalign's Introduction

docAlign

This repository contains code of the docAlign pipeline, a Nextflow and Docker Version of MMSeq2 software tools for searching and clustering huge protein and nucleotide sequence sets.

Description of the files:

  • docAlign.nf - Nextflow pipeline implemeting the protein sequence search and alignment to a database
  • Dockerfile - A docker file for building a docker image of the pipeline

Bulding the docker image:

Note: Ensure you have docker installed and running on your machine.

  • Clone this repository: git clone https://github.com/Fredrick-Kakembo/docAlign.git
  • cd docAlign
  • Build the Docker image: docker build -t docAlign .

This will create a docker image of the pipeline called docAlign that will contain all the required dependencies required to run the pipeline. These include; conda, git, wget, MMSeq2, Nextflow.

Test your docker image: docker run dockAlign
This will run the docAlign search tool using the example sequence data provided along with the pipeline.

Usage:

nextflow run docAlign.nf \
    --sequences /path/to/protein/sequences \
    --databases /path/to/database \
    --outdir <output Directory> \
    -with-docker docAlign

The --outdir option is optional. Default is results. It specifies the output directory. Also the path to the sequences and databases should be an absolute path, or specifying the ${PWD} before your inputs.

Example Run

nextflow run docAlign.nf \
    --sequence ${PWD}/QUERY.fasta \
    --database ${PWD}/DB.fasta 
    --outdir Example 
    -with-docker docAlign

docalign's People

Contributors

fredrick-kakembo avatar

Stargazers

 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.