DOCKER/README.md

   1 # Official MACS2 v2.2.6 docker
   2
   3 MACS2 is a bioinformatics algorithm to analyze ChIP-seq datasets.
   4
   5 # Get Started
   6
   7 ## Pull the image
   8
   9 Currently, there are two types of MACS2 images, one based on official Python3.7 docker image, and the other based on official Python3.7-slim docker image. Only if space is a concern, and you keep using Python3.7-slim docker for all the Python 3.7 applications, pull the slim one.
  10
  11 To pull the regular MACS2 image:
  12
  13 ```docker pull fooliu/macs2```
  14
  15 To pull the MACS2 image based on Python3.7-slim
  16
  17 ```docker pull fooliu/macs2:py37-slim```
  18
  19 ## Analyze your data
  20
  21 ### Example of analyzing ChIP-seq data in the CURRENT directory
  22
  23 Let's assume you pulled the regular MACS2 image. If not, change the image name accordingly. First, ```cd``` to the working directory containing ChIP-seq alignment files such as ```chip-seq-file.bam``` and ```control-seq-file.bam```. Then
  24
  25 ```docker run -v $PWD:/data/ fooliu/macs2 callpeak -t /data/chip-seq-file.bam -c /data/control-seq-file.bam -n test-run --outdir /data/```
  26
  27 The first part ```-v $PWD:/data/``` will mount the CURRENT directory ```$PWD``` to ```/data/``` in the container, so please don't forget to add ```/data/``` to the path of input files with ```-t``` and/or ```-c```, and don't forget to set the ```--outdir``` option to ```/data/```. The final outputs will be directly written into the CURRENT directory. Extra MACS2 options can be modified or added after ```docker run -v $PWD:/data/ fooliu/macs2```. The ENTRYPOINT (or the default command when run the container) has been set as ```macs2```.
  28
  29 # Built with
  30
  31 * Python3.7 docker image 3.7
  32 * pip install numpy version 1.17, cython 0.29, and pytest 4.6
  33 * git clone MACS codes from github master branch then run ```setup.py```
  34
  35 # Author
  36
  37 This Docker image is maintained and uploaded by Tao Liu <vladimir.liu@gmail.com>. MACS2 is actively maintained on Github, many users contribute codes and suggestions.