Git Product home page Git Product logo

methpipe's Introduction

The MethPipe software package is a computational pipeline for analyzing bisulfite sequencing data (WGBS and RRBS). MethPipe provides tools for mapping bisulfite sequencing read and estimating methylation levels at individual cytosine sites. Additionally, MethPipe also includes tools for identifying higher-level methylation features, such as hypo-methylated regions (HMR), partially methylated domains (PMD), hyper-methylated regions (HyperMR), and allele-specific methylated regions (AMR).

Building and Installing

You may download the latest stable release from:http://smithlabresearch.org/software/methpipe/
This software package has been designed to operate in a UNIX-like environment. It has been tested on MacOS X Snow Leopard and Linux.

  • Step 0

    This software package requires a functioning installation of the GNU Scientific Library (GSL). If you don't already have this installed, you will need to download and install it from http://www.gnu.org/software/gsl/

  • Step 1

    To build the binaries, type the following, where '>' is your prompt and the CWD is the root of the distribution:

    > make all
    
  • Step 2

    To install the binaries, type the following, where '>' is your prompt and the CWD is the root of the distribution:

    > make install
    

    This will place the binaries in the bin directory under the package root. They can be used directly from there without any additional steps. You can add that directory to your PATH environment variable to avoid having to specify their full paths, or you can copy the binaries to another directory of your choice in your PATH

For advanced users who are interested in the newest features, you may obtain the latest source code by cloning the MethPipe repository:

> git clone --recursive https://github.com/smithlabcode/methpipe.git

After you clone the latest source code, follow the above steps for installation.

Usage

Read methpipe-manual.pdf in the docs directory.

Contacts and bug reports

Andrew D. Smith [email protected]

Qiang Song [email protected]

MethPipe and MethBase Users' Mailinglist [email protected] http://groups.google.com/group/methpipe?hl=en

Copyright and License Information

Copyright (C) 2013 University of Southern California, Andrew D. Smith, Qiang Song, Fang Fang, Ben Decato and Meng Zhou

Authors: Andrew D. Smith, Qiang Song, Fang Fang, Ben Decato and Meng Zhou

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, either version 3 of the License, or (at your option) any later version.

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

SamTools Copyright (c) 2008-2009 Genome Research Ltd. SamTools software is free software distributed under the MIT License. Refer to the COPYING file in src/samtoos/ for further information.

methpipe's People

Contributors

songqiang avatar andrewdavidsmith avatar bdecato avatar egor-dolzhenko avatar jqujqu avatar mengzhou avatar xjlizji avatar pjuren avatar saketkc avatar wenzhenl avatar

Watchers

Sarah Ma 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.