sccomp_glm: sccomp_glm main

Description Usage Arguments Value

View source: R/methods.R

Description

This function runs the data modelling and statistical test for the hypothesis that a cell_type includes outlier biological replicate.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
sccomp_glm(
  .data,
  formula,
  .sample,
  .cell_group,
  .count = NULL,
  check_outliers = TRUE,
  approximate_posterior_inference = FALSE,
  verbose = FALSE,
  noise_model = "multi_beta_binomial",
  cores = detectCores(),
  seed = 42
)

Arguments

.data

A tibble including a cell_type name column | sample name column | read counts column | covariate columns | Pvaue column | a significance column

formula

A formula. The sample formula used to perform the differential cell_type abundance analysis

.sample

A column name as symbol. The sample identifier

.cell_group

A column name as symbol. The cell_type identifier

.count

A column name as symbol. The cell_type abundance (read count)

approximate_posterior_inference

A boolean. Whether the inference of the joint posterior distribution should be approximated with variational Bayes. It confers execution time advantage.

cores

An integer. How many cored to be used with parallel calculations.

seed

An integer. Used for development and testing purposes

Value

A nested tibble tbl with cell_group-wise statistics


stemangiola/sccompTemp documentation built on Dec. 23, 2021, 5:30 a.m.