/swagg

Primary LanguageHTMLMIT LicenseMIT

swagg

image

The SWAGG Pipeline is is designed to create graph genomes from read data. The input into the pipeline is a set of reads with a reference genomes, and the reads can be short reads or preprocessed long reads. Thereafter the reads are sent through a stage where they are assembled into longer contigs, and the resultant contigs are mapped back to the reference genome to look for discrepancies with the reference genome. These "discrepancies" or mutations are found using structural variant tools that output VCF files per read set. These VCF files are taken together to contrstruct the genome graph at the end of the pipeline.

Pipeline Overview

image

You can make a free DOI with zenodo

Website (if applicable)

Intro statement

What's the problem?

Why should we solve it?

What is ?

Overview Diagram

How to use

Software Workflow Diagram

File structure diagram

Define paths, variable names, etc

Installation options:

We provide two options for installing : Docker or directly from Github.

Docker

The Docker image contains as well as a webserver and FTP server in case you want to deploy the FTP server. It does also contain a web server for testing the main website (but should only be used for debug purposes).

  1. docker pull ncbihackathons/<this software> command to pull the image from the DockerHub
  2. docker run ncbihackathons/<this software> Run the docker image from the master shell script
  3. Edit the configuration files as below

Installing from Github

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. Edit the configuration files as below
  3. sh server/<this software>.sh to test
  4. Add cron job as required (to execute .sh script)

Configuration

Examples here

Testing

We tested four different tools with . They can be found in server/tools/ .

Additional Functionality

DockerFile

comes with a Dockerfile which can be used to build the Docker image.

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. cd server
  3. docker build --rm -t <this software>/<this software> .
  4. docker run -t -i <this software>/<this software>

Website

There is also a Docker image for hosting the main website. This should only be used for debug purposes.

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. cd Website
  3. docker build --rm -t <this software>/website .
  4. docker run -t -i <this software>/website