chipseq: Detection and annotation of TF binding sites and histone...

In kendomaniac/docker4seq: Running NGS computing demanding applications, e.g reads mapping and counting, wrapped in docker containers

Detection and annotation of TF binding sites and histone marks, based on the workflow used in Galli et al Mol Cell. 2015 Oct 15;60(2):328-37

Description

This function executes the docker container chipseq.8 and requires as input two bam files, one for the chipseq of interest and the other for control, e.g. mock, which can be generated with bwa function.

Usage

chipseq(
  group = c("sudo", "docker"),
  bam.folder = getwd(),
  sample.bam,
  ctrl.bam,
  scratch.folder = "/data/scratch",
  genome = c("hg19", "hg38", "mm9", "mm10"),
  read.size,
  tool = c("macs", "sicer"),
  macs.min.mfold = 10,
  macs.max.mfold = 30,
  macs.pval = "1e-5",
  sicer.wsize = 200,
  sicer.gsize = c(200, 600),
  sicer.fdr = 0.1,
  tss.distance = 0,
  max.upstream.distance = 10000,
  remove.duplicates = c("Y", "N")
)

Arguments

group	a character string. Two options: "sudo" or "docker", depending to which group the user belongs
bam.folder	a character string indicating where bam files are located
sample.bam	a character string indicating the chipseq file under analysis
ctrl.bam	a character string indicating the control file, e.g. unspecific IgG, input DNA, etc.
scratch.folder	a character string indicating the scratch folder where docker container will be mounted
genome	a character string indicating the genome used as reference for data generation. Available options: hg19, hg38, mm9, mm10
read.size	an integer indicating the length of the sequenced reads
tool	a character string indicating the peaks calling algorith. Available options: macs and sicer. Macs, v 1.14, is used to call TF peaks, as instead sicer, v 1.1, is used to call histone mark peaks
macs.min.mfold	an integer indicating the minimum enrichment ratio against background
macs.max.mfold	an integer indicating the maximum enrichment ratio against background
macs.pval	a character string, indicationg the pvalue cutoff to be used to filter peaks with low statistical significance.The number must be provided in scientific notation as the default value shows
sicer.wsize	an integer indicating the windows size to be used by sicer
sicer.gsize	an integer indicating the gap size to be used by sicer. Suggested values: H3K4Me3=200; H3K27Me3=600
sicer.fdr	an integer indicating the pvalue cutoff to be used to filter peaks with low statistical significance
tss.distance	an integer indicating the distance of TSS with respect to gene start
max.upstream.distance	an integer indicating the maximum distance to associate a gene ID to a peak
remove.duplicates	a character string indicating if duplicated reads have to be removed. Available options: Y, to remove douplicates, N to keep duplicates

Value

three files: dedup_reads.bam, which is sorted and duplicates marked bam file, dedup_reads.bai, which is the index of the dedup_reads.bam, and dedup_reads.stats, which provides mapping statistics

Examples

## Not run: 
    system("wget http://130.192.119.59/public/SRR1172111.bam")#TEAD
    system("wget http://130.192.119.59/public/SRR1172110.bam")#igg
    system("wget http://130.192.119.59/public/SRR1592211.bam")#H3K27ac
    #running chipseq for macs
    chipseq(group="sudo",bam.folder=getwd(), sample.bam="SRR1172111.bam", ctrl.bam="SRR1172110.bam",
    scratch.folder="/data/scratch", genome="hg19", read.size=50,
    tool="macs", macs.min.mfold=10, macs.max.mfold=30, macs.pval="1e-5",
    sicer.wsize=200, sicer.gsize=200, sicer.fdr=0.10, tss.distance=0, max.upstream.distance=10000,
    remove.duplicates="N")

    #running chipseq for sicer H3K4Me3
    chipseq(group="sudo",bam.folder=getwd(), sample.bam="SRR1592211.bam", ctrl.bam="SRR1172110.bam",
    scratch.folder="/data/scratch", genome="hg19", read.size=50,
    tool="sicer", sicer.wsize=200, sicer.gsize=200, sicer.fdr=0.10,
    tss.distance=0, max.upstream.distance=10000,remove.duplicates="N")

## End(Not run)

kendomaniac/docker4seq documentation built on Sept. 3, 2024, 6:42 p.m.