Skip to main content

ChIP-R is a method for assessing the reproducibility of replicated ChIP-seq type experiments. It incorporates the rank product method, a novel thresholding methods, and the use of peak fragmentation return the most reproducible peaks.

Project description

ChIP-R ("chipper")

ChIP-R uses an adaptation of the rank product statistic to assess the reproducibility of ChIP-seq peaks by incorporating information from multiple ChIP-seq replicates and "fragmenting" peak locations to better combine the information present across the replicates.

Install

  • Python3.x with the following packages:
  • Numpy
  • Scipy
  • pyBigWig

To install ChIP-R:

pip install ChIP-R

OR if you want to install from source:

git clone https://github.com/rhysnewell/ChIP-R.git
cd ChIP-R
python3 setup.py install

Usage

In the command line, type in 'chipr -h ' for detailed usage.

$ chipr -h

usage: chipr [-h] -i INPUT [INPUT ...] [-o OUTPUT] [-m MINENTRIES]
         [--rankmethod RANKMETHOD] [--duphandling DUPHANDLING]
         [--seed RANDOM_SEED] [-a ALPHA]

Combine multiple ChIP-seq files and return a union of all peak locations and a
set confident, reproducible peaks as determined by rank product analysis

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT [INPUT ...], --input INPUT [INPUT ...]
                        ChIP-seq input files. These files must be in either
                        narrowPeak, broadPeak, or regionPeak format. Multiple
                        inputs are separeted by a single space
  -o OUTPUT, --output OUTPUT
                        ChIP-seq output filename prefix
  -B, --bigbed          Specify if input files are in BigBed format
  -m MINENTRIES, --minentries MINENTRIES
                        The minimum peaks between replicates required to form
                        an intersection of the peaks Default: 1
  --rankmethod RANKMETHOD
                        The ranking method used to rank peaks within
                        replicates. Options: 'signalvalue', 'pvalue',
                        'qvalue'. Default: pvalue
  --duphandling DUPHANDLING
                        Specifies how to handle entries that are ranked
                        equally within a replicate Can either take the
                        'average' ranks or a 'random' rearrangement of the
                        ordinal ranks Options: 'average', 'random' Default:
                        'average'
  --seed RANDOM_SEED    Specify a seed to be used in conjunction with the
                        'random' option for -duphandling Must be between 0 and
                        1 Default: 0.5
  -a ALPHA, --alpha ALPHA
                        Alpha specifies the user cut-off value for set of
                        reproducible peaks The analysis will still produce
                        results including peaks within the threshold
                        calculatedusing the binomial method Default: 0.05

Example

$ chipr -i input_prefix1.bed input_prefix2.bed input_prefix3.bed input_prefix4.bed -m 2 -o output_prefix   

Output

Important result files:

  • prefixname_ALL.bed: All intersected peaks, ordered from most significant to least (10 columns)
  • prefixname_T2.bed: The tier 2 intersected peaks, the peaks that fall within the binomial threshold (10 columns)
  • prefixname_T1.bed: The tier 1 intersected peaks, the peaks that fall within the user defined threshold (10 columns)
  • prefixname_log.txt: A log containing the number of peaks appearing in each tier.

prefixname.bed file has 10 columns. The output follows the standard peak format for bed files, with the addition of a 10th column that specifies the ranks of the peaks that produced this possible peak. See the toy example below.

chr start end name score strand signalValue p-value q-value
chr1 9118 10409 T3_peak_87823 491 . 15.000000 0.113938 0.712353

Citation

Contact

Authors: Rhys Newell, Michael Piper, Mikael Boden, Alexandra Essebier

Contact: rhys.newell(AT)uq.edu.au

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ChIP-R-1.1.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

ChIP_R-1.1-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file ChIP-R-1.1.tar.gz.

File metadata

  • Download URL: ChIP-R-1.1.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for ChIP-R-1.1.tar.gz
Algorithm Hash digest
SHA256 cfa53246d9c2e2a8507bf4c40977a6d60ed0384c67703a158fe346b42edf06d5
MD5 5f2dc2deea106e604aa0115397d186ab
BLAKE2b-256 b2f96e069ea099b74ffdf49a99ea30db75014f3bb96bdf44357308c6bb3853f7

See more details on using hashes here.

File details

Details for the file ChIP_R-1.1-py3-none-any.whl.

File metadata

  • Download URL: ChIP_R-1.1-py3-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for ChIP_R-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c53693e896e8c5a7f0143e08ccaef4f5ac0cdbcb4ef65e92e1d6eb681fa1474e
MD5 0d528ba85295a4e64351c769c6f74d92
BLAKE2b-256 2a368cefa93e6f4d351d542dc76747319ee2dbd992794dd3fc790b3a9348acf2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page