======
Segway
======
by Michael Hoffman <michael.hoffman at utoronto dot ca>

.. image:: https://badges.gitter.im/Join%20Chat.png
   :alt: Join the chat at https://gitter.im/hoffman/segway
   :target: https://gitter.im/hoffman/segway?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. image:: https://drone.io/bitbucket.org/hoffmanlab/segway/status.png
    :target: https://drone.io/bitbucket.org/hoffmanlab/segway/latest
    :alt: Build Status

.. image:: https://pypip.in/version/segway/badge.png
    :target: https://pypi.python.org/pypi/segway/
    :alt: Latest Version

.. image:: https://pypip.in/download/segway/badge.png
    :target: https://pypi.python.org/pypi/segway/
    :alt: Downloads

Description
===========
The free Segway software package contains a novel method for analyzing multiple
tracks of functional genomics data. Our method uses a dynamic Bayesian network
(DBN) model, which enables it to analyze the entire genome at 1-bp resolution
even in the face of heterogeneous patterns of missing data. This method is the
first application of DBN techniques to genome-scale data and the first genomic
segmentation method designed for use with the maximum resolution data available
from ChIP-seq experiments without downsampling. Our software has extensive
documentation and was designed from the outset with external users in mind.
Researchers at other universities and institutes have already installed and
used Segway for their own projects.

Please see the following URL for information,
installation, and support: http://pmgenomics.ca/hoffmanlab/proj/segway/

Documentation
=============

Live documentation based on this repository can be found on `Read the Docs`_.

.. _Read the Docs: http://segway.readthedocs.org/en/latest/


Contributing
============

Contributions to Segway are always welcome and encouraged. See `CONTRIBUTING
<CONTRIBUTING.rst>`__ for more information on how to get started.

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

Segway 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.

Contact
=======
Please let me <michael.hoffman at utoronto dot ca> know if you have any
comments on the installation or use of Segway. I would love to know
if you get it working on a system not listed above.