| Title: | BEAT - BS-Seq Epimutation Analysis Toolkit |
|---|---|
| Description: | Model-based analysis of single-cell methylation data |
| Authors: | Kemal Akman <[email protected]> |
| Maintainer: | Kemal Akman <[email protected]> |
| License: | LGPL (>= 3.0) |
| Version: | 1.45.0 |
| Built: | 2024-11-18 03:10:24 UTC |
| Source: | https://github.com/bioc/BEAT |
Modelling, data preparation and analysis of BS-Seq derived, region-based epimutation data
| Package: | BEAT - Rpackage |
| Type: | Package |
| Version: | 0.99.1 |
| Date: | 2013-01-10 |
| License: | LGPL version 3 or later |
| Maintainer: | Kemal Akman, [email protected] |
Returns epimutation rates per genome and per genomic feature, as well as individual genomic sites at which epimutations were called.
epimutation_calls(params, outputPath = getwd())epimutation_calls(params, outputPath = getwd())
params |
BEAT parameter object. |
outputPath |
Path to which output files will be written, the default is the current working directory. |
Necessary function arguments are passed via a BEAT parameter object, which includes working path, sample names, reference sample name, model parameters and region sizes.
Parameter object created by calling makeParams.
The function epimutation_calls returns :
resultsList |
A list is returned consisting of the two data.frames methSites and demethSites. methSites contains all regions at which methylating epimutations were observed, while demethSites contains all sites at which demethylating epimutations were observed. Each data.frame describes the genomic regions covered by the given sample and the reference sample using the columns: 'chr' (chromosome), 'start' (starting position), 'stop' (last position), 'meth' (methylated counts), 'unmeth' (unmethylatd counts) and 'epimutation_call_test' (epimutation call, 1 for methylating epimutation and $-1$ for demethylating epimutation). |
methEpicalls |
For each single-cell sample, a methEpicalls.RData object is saved in the working directory, which is a data.frame of all sites at which methylating epimutations were observed, consisting of the columns: chr, pos, endpos, meth, unmeth and methstate. |
demethEpicalls |
For each single-cell sample, a demethEpicalls.RData object is saved in the working directory, which is a data.frame of all sites at which demethylating epimutations were observed, consisting of the columns: chr, pos, endpos, meth, unmeth and methstate. |
Kemal Akman <[email protected]>
See also makeParams.
# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # pool CG positions into regions positions_to_regions(params) # compute model statistics generate_results(params) # call epimutations methDemethPlusMinus <- epimutation_calls(params)# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # pool CG positions into regions positions_to_regions(params) # compute model statistics generate_results(params) # call epimutations methDemethPlusMinus <- epimutation_calls(params)
Computes model methylation states for genomic region counts of a list of samples.
generate_results(params, outputPath = getwd())generate_results(params, outputPath = getwd())
params |
BEAT parameter object. |
outputPath |
Path to which output files will be written, the default is the current working directory. |
Necessary function arguments are passed via a BEAT parameter object, which includes working path, sample names, reference sample name, model parameters and region sizes.
Parameter object created by calling makeParams.
Kemal Akman <[email protected]>
See also makeParams.
# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # pool CG positions into regions positions_to_regions(params) # compute model statistics generate_results(params)# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # pool CG positions into regions positions_to_regions(params) # compute model statistics generate_results(params)
Creates a parameter object of arguments to be used with other BEAT functions.
makeParams(localpath = getwd(), sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE)makeParams(localpath = getwd(), sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE)
localpath |
Full path to working directory from which files are read and where results are saved. |
sampNames |
Vector of sample names to be analyzed. |
convrates |
Vector of empirically determined bisulfite conversion rates per sample. Determines p+, the model parameter for incomplete conversion (false negative rates). |
is.reference |
Vector of reference (TRUE) vs. single-cell (FALSE) status per sample. |
pminus |
Model parameter for false conversion (false positive rate). |
regionSize |
Region size in nucleotides into which genomic sites are grouped. |
minCounts |
Minimum counts necessary for each region to be included in epimutation modeling and analysis. |
verbose |
Shows more verbose console output during computation steps. |
computeRegions |
If set to TRUE, regions will be recomputed from individual positions and saved as cpgregions.RData objects for each sample. |
computeMatrices |
If set to TRUE, model parameters will be recomputed and saved as results.RData objects for each sample. |
writeEpicallMatrix |
If set to TRUE, epimutation calls will be written as RData object. |
The function makeParams returns :
params |
Parameter object to be used in other BEAT functions. |
Kemal Akman <[email protected]>
# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # Example usage of the params object positions_to_regions(params)# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # Example usage of the params object positions_to_regions(params)
Sample dataset of CpG positions for a single cell sequencing sample
Kemal Akman <[email protected]>
Converts methylation counts of a data.frame of single genomic positions into a data.frame of counts for genomic regions.
positions_to_regions(params, outputPath = getwd())positions_to_regions(params, outputPath = getwd())
params |
BEAT parameter object. |
outputPath |
Path to which output files will be written, the default is the current working directory. |
Necessary function arguments are passed via a BEAT parameter object, which includes working path, sample names, reference sample name, model parameters and region sizes.
Parameter object created by calling makeParams.
For each sample referenced by the params argument sampleNames, a corresponding csv must be present in the working directory. The csv input must contain one row per genomic position for each CG site. Columns must be chr, pos, meth, unmeth (chromosome, position, methylated counts, unmethylated counts).
Kemal Akman <[email protected]>
See also makeParams.
# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # Pool CG positions into regions positions_to_regions(params)# Local working directory localpath <- system.file('extdata', package = 'BEAT') # Names of samples, expected filenames are e.g. reference.positions.csv sampNames <- c("reference", "sample") # Empirical BS-conversion rates, e.g. estimated from non-CpG methylation convrates <- c(0.8,0.5) # Vector denoting reference vs. single-cell status of given samples is.reference <- c(TRUE,FALSE) params <- makeParams(localpath, sampNames, convrates, is.reference, pminus = 0.2, regionSize = 10000, minCounts = 5, verbose = TRUE, computeRegions = TRUE, computeMatrices = TRUE, writeEpicallMatrix = TRUE) # Pool CG positions into regions positions_to_regions(params)
Sample dataset of CpG positions for a single cell sequencing sample
Kemal Akman <[email protected]>