Merge pull request #645 from macs3-project/feat/macs3/narrowpeak
[MACS.git] / README.md
blobb71569c67a8018c7e3fa0f719cd13402f5e68b8d
1 # MACS: Model-based Analysis for ChIP-Seq
3 ![Status](https://img.shields.io/pypi/status/macs3.svg) ![License](https://img.shields.io/github/license/macs3-project/MACS) ![Programming languages](https://img.shields.io/github/languages/top/macs3-project/MACS) ![CI x64](https://github.com/macs3-project/MACS/workflows/MACS3%20CI%20x64/badge.svg?branch=master) ![CI non x64](https://github.com/macs3-project/MACS/workflows/MACS3%20CI%20non%20x64/badge.svg?branch=master) ![CI Mac OS](https://github.com/macs3-project/MACS/actions/workflows/build-and-test-MACS3-macos.yml/badge.svg?branch=master)
5 [![PyPI
6 download](https://img.shields.io/pypi/dm/macs3?label=pypi%20downloads)](https://pypistats.org/packages/macs3)
8 Latest Release:
9 * Github: [![Github Release](https://img.shields.io/github/v/release/macs3-project/MACS)](https://github.com/macs3-project/MACS/releases)
10 * PyPI: [![PyPI Release](https://img.shields.io/pypi/v/macs3.svg)](https://pypi.org/project/MACS3/)
11 * Bioconda:[![Bioconda Badge](https://anaconda.org/bioconda/macs3/badges/version.svg)](https://anaconda.org/bioconda/macs3)
12 * Debian Med: [![Debian Stable](https://img.shields.io/debian/v/macs/stable?label=debian%20stable)](https://packages.debian.org/stable/macs)[![Debian Unstable](https://img.shields.io/debian/v/macs/sid?label=debian%20sid)](https://packages.debian.org/sid/macs)
15 ## Introduction
17 With the improvement of sequencing techniques, chromatin
18 immunoprecipitation followed by high throughput sequencing (ChIP-Seq)
19 is getting popular to study genome-wide protein-DNA interactions. To
20 address the lack of powerful ChIP-Seq analysis method, we presented
21 the **M**odel-based **A**nalysis of **C**hIP-**S**eq (MACS), for
22 identifying transcript factor binding sites. MACS captures the
23 influence of genome complexity to evaluate the significance of
24 enriched ChIP regions and MACS improves the spatial resolution of
25 binding sites through combining the information of both sequencing tag
26 position and orientation. MACS can be easily used for ChIP-Seq data
27 alone, or with a control sample with the increase of
28 specificity. Moreover, as a general peak-caller, MACS can also be
29 applied to any "DNA enrichment assays" if the question to be asked is
30 simply: *where we can find significant reads coverage than the random
31 background*.
33 Please find MACS3 documentations through [MACS3
34 website](https://macs3-project.github.io/MACS/).
36 ## Contribute
38 Please read our [CODE OF CONDUCT](CODE_OF_CONDUCT.md) and [How to
39 contribute](CONTRIBUTING.md) documents. If you have any questions,
40 suggestion/ideas, or just want to have conversions with developers and
41 other users in the community, we recommend using the [MACS
42 Discussions](https://github.com/macs3-project/MACS/discussions)
43 instead of posting to our
44 [Issues](https://github.com/macs3-project/MACS/issues) page.
46 ## Ackowledgement
48 MACS3 project is sponsored by
49 [CZI EOSS](https://chanzuckerberg.com/eoss/). And we particularly want
50 to thank the user community for their supports, feedbacks and
51 contributions over the years.
53 ## Citation
55 2008: [Model-based Analysis of ChIP-Seq
56 (MACS)](https://genomebiology.biomedcentral.com/articles/10.1186/gb-2008-9-9-r137)