getAnnotationCorrelation: getAnnotationCorrelation

In chromVAR: Chromatin Variation Across Regions

Description

getAnnotationCorrelation

Usage

getAnnotationCorrelation(object, annotations, ...)


  ## S4 method for signature 'SummarizedExperiment,SummarizedExperiment'
getAnnotationCorrelation(object,
  annotations, background_peaks = getBackgroundPeaks(object),
  expectation = computeExpectations(object), variabilities = NULL)


  ## S4 method for signature 'SummarizedExperiment,MatrixOrmatrix'
getAnnotationCorrelation(object,
  annotations, background_peaks = getBackgroundPeaks(object),
  expectation = computeExpectations(object), variabilities = NULL)

## S4 method for signature 'SummarizedExperiment,list'
getAnnotationCorrelation(object,
  annotations, background_peaks = getBackgroundPeaks(object),
  expectation = computeExpectations(object), variabilities = NULL)


  ## S4 method for signature 'MatrixOrmatrix,SummarizedExperiment'
getAnnotationCorrelation(object,
  annotations, background_peaks, expectation = computeExpectations(object),
  variabilities = NULL)

## S4 method for signature 'MatrixOrmatrix,MatrixOrmatrix'
getAnnotationCorrelation(object,
  annotations, background_peaks, expectation = computeExpectations(object),
  variabilities = NULL)

## S4 method for signature 'MatrixOrmatrix,list'
getAnnotationCorrelation(object, annotations,
  background_peaks, expectation = computeExpectations(object),
  variabilities = NULL)

Arguments

object	result from computeDeviations
annotations	SummarizedExperiment of annotation matches
...	additional arguments
background_peaks	optional, matrix of background peaks
expectation	optional, expected fraction of reads per peak, as computed by computeExpectations
variabilities	optional, variabilities computed from computeVariability

Details

should only be run on small number of motifs/kmers/peaksets (very slow!)

Value

correlation matrix

Methods (by class)

• object = SummarizedExperiment,annotations = SummarizedExperiment: object and annotations are SummarizedExperiment

• object = SummarizedExperiment,annotations = MatrixOrmatrix: object is SummarizedExperiment, annotations are Matrix

• object = SummarizedExperiment,annotations = list: object is SummarizedExperiment, annotations are list

• object = MatrixOrmatrix,annotations = SummarizedExperiment: object and annotations are SummarizedExperiment

• object = MatrixOrmatrix,annotations = MatrixOrmatrix: object is SummarizedExperiment, annotations are Matrix

• object = MatrixOrmatrix,annotations = list: object is SummarizedExperiment, annotations are list

chromVAR documentation built on Nov. 8, 2020, 6:46 p.m.