TRESS_DMRfit: Differential m6A methylation analysis for MeRIP-seq data...
In haowulab/TRESS: Toolbox for mRNA epigenetics sequencing analysis

TRESS_DMRfit

R Documentation

Differential m6A methylation analysis for MeRIP-seq data under general experimental design

Description

This function performs differential m6A analysis through the following three steps:

Divide the whole genome to obtain bin-level read counts: DivideBins
Call candidate differential m6A methylation regions (DMRs): CallCandidates
Model fitting on candidate DMRs based on Negative Binomial distribution: CallDMRs.paramEsti

Usage

TRESS_DMRfit(IP.file, Input.file, Path_To_AnnoSqlite,
             variable = NULL, model = NULL,
             InputDir, OutputDir = NA,
             experimentName = NA,
             binsize = 50,
             filetype = "bam",
             IncludeIntron = FALSE,
             filterRegion = TRUE,
             shrkPhi = TRUE,
             addsuedo = FALSE)

Arguments

`IP.file`	A vector of characters containing the name of BAM files for all IP samples.
`Input.file`	A vector of characters containing the name of BAM files for all input control samples.
`Path_To_AnnoSqlite`	A character to specify the path to a "*.sqlite" file used for genome annotation.
`variable`	A dataframe containing condition information of all samples. Default is NULL.
`model`	A formula to specify which factor in "variable" will be included into design for model fitting. Default is NULL.
`InputDir`	A character to specify the input directory of all BA, files.
`OutputDir`	A character to specify an output directory to save bin-level and region-level data. Default is NA, which will not save any results.
`experimentName`	A character to specify the name of results if "OutputDir" is provided.
`binsize`	A numerical value to specify the size of window to bin the genome. Default value is 50.
`filetype`	A character to specify the format of input data. Possible choices are: "bam", "bed" and "GRanges". Default is "bam".
`IncludeIntron`	A logical value indicating whether to include (TRUE) intronic regions or not (False). Default is FALSE.
`filterRegion`	A logical value indicating whether to filter out candidate DMRs based on their marginal coefficient of variation (CV) in methylation ratios. If TRUE, then a candidate DMR with CV < 25% quantile would be filtered out. Default value is TRUE.
`shrkPhi`	A logical value to indicate whether conducting shringkage estimate for dispersion parameter. Default is TRUE.
`addsuedo`	A logical value to indicate whether or not adding a psuedo count 5 on raw read counts. Default is FALSE.

Details

For complete details on each step (especially step 3) in above "Description" section, please see the manual pages of respective functions.

Value

This function generates three sets of results: "allBins", "Candidates" and "DMRfit" returned respectively by function DivideBins, CallCandidates and CallDMRs.paramEsti. If "OutputDir" is not specified, only "DMRfit" will be returned. If "OutputDir" is specified, in addition to returning "DMRfit", "allBins" and "Candidates" will also be saved under the provided output directory.

Detailed structure of "DMRfit", "Candidates" and "allBins" can be found in the manual of respective functions.

Author(s)

Zhenxing Guo <zhenxing.guo@emory.edu>

References

Zhenxing Guo, Andrew M. Shafik, Peng Jin, Hao Wu. "Differential RNA Methylation Analysis for MeRIP-seq Data under General Experimental Design."

Examples

## Not run: 
Input.file = c("input1.bam", "input2.bam",..., "inputN.bam")
IP.file = c("ip1.bam", "ip2.bam", ..., "ipN.bam")
InputDir = "/directory/to/BAMfile"
OutputDir = "/directory/to/output"
Path_sqlit = "/path/to/xxx.sqlite"
design = "YourDesign"
model = "YourModel"
DMR.fit = TRESS_DMRfit(IP.file = IP.file,
                       Input.file = Input.file,
                       Path_To_AnnoSqlite = Path_sqlit,
                       variable = design,
                       model = model,
                       InputDir = InputDir,
                       OutputDir = OutputDir,
                       experimentName = "example"
                       )
                       
## End(Not run)

haowulab/TRESS documentation built on Aug. 27, 2022, 7:11 p.m.