Lightweight web server to query bam files
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.document
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
README.rdoc
Rakefile
VERSION

README.md

bio-samtools-server

Build Status

This is a standalone server to query BAM files (and the corresponding reference). The server will return the content of a BAM file in the selected folder when the server is started up. The server used is sintra.

Note: this software is under active development!

Installation

gem install bio-samtools-server

Usage

require 'bio-samtools-server'

The API doc is online. For more code examples see the test files in the source tree.

To run the server:

bam-server.rb  -r FOLDER_WITH_REFERENCES --bam FOLDER_WITH_BAM_FILES

On the web browser, the following outputs are implemented (so far). The first element in the path is the file with the reference, the second the BAM file (without extension) and the parameter "region" is used to query

WIG TEST:

http://localhost:4567/test_chr.fasta/testu/wig?region=chr_1:1-100&step_size=5

the param step_size sets the number of positions to be averaged. See the wiggle documentation

ALIGNMENT TEST

http://localhost:4567/test_chr.fasta/testu/alignment?region=chr_1:1-100

LIST

http://localhost:4567/test_chr.fasta/testu/list

Reference

http://localhost:4567/test_chr.fasta/testu/reference?region=chr_1:1-100

Project home page

Information on the source tree, documentation, examples, issues and how to contribute, see

http://github.com/homonecloco/bioruby-samtools-server

Cite

If you use this software, please cite one of

Biogems.info

This Biogem is published at (http://biogems.info/index.html#bio-samtools-server)

Copyright

Copyright (c) 2014 homonecloco. See LICENSE.txt for further details.