get_stats: Estimate descriptive statistics for each sample

Description Usage Arguments Details Value Examples

View source: R/scmethrix_operations.R

Description

Estimate descriptive statistics for each sample

Usage

1
2
3
4
5
6
7
8
get_stats(
  scm = NULL,
  assay = "score",
  per_chr = TRUE,
  verbose = TRUE,
  ignore_chr = NULL,
  ignore_samples = NULL
)

Arguments

scm

scMethrix; the single cell methylation experiment

assay

string; name of an existing assay. Default = "score"

per_chr

boolean; Estimate stats per chromosome. Default TRUE

verbose

boolean; Flag for outputting function status messages. Default = TRUE

ignore_chr

string; list of chromosomes to ignore

ignore_samples

string; list of samples to ignore

Details

Calculate descriptive statistics (mean, median, SD) either by sample or per_chr

Value

data.table of summary stats

Examples

1
2
3
4
5
6
7
data('scMethrix_data')

#Get stats for each sample and chromosome
get_stats(scMethrix_data)

#Get stats for each sample
get_stats(scMethrix_data,per_chr = FALSE)

CompEpigen/scMethrix documentation built on Nov. 6, 2021, 3:09 p.m.