SSNscore_default: SSNscore_default

View source: R/ssn.R

SSNscore_defaultR Documentation

SSNscore_default

Description

compute the aggregated SSN score for each group

Usage

SSNscore_default(
  object,
  K,
  freq = 0.5,
  meta = NULL,
  method = c("mean", "sum"),
  mean_by = c("K", "genes")
)

Arguments

object

S4::SSN

K

an integer, the top K genes by order of CI

freq

percentage for selection of each group's genes. That is, n_sample = freq * #repeats in one group, and n_gene = (in this group how many repeats enriched this gene). If n_gene >= n_sample, this gene is selected for this group

meta

group information for all samples (repeats), a data.frame with 1-col, or NULL (default). If NULL, object@score@meta.data should have any column and the first will be used

method

method for aggregating the gene expression to calculate the score of each sample, by average (mean, default) or summation (sum)

mean_by

if method == mean, where the total number is K (default) or the actual number of genes

Value

S4::SSN object, result will be stored in object@score


Kaiyu-W/DNBr documentation built on April 27, 2024, 10:09 a.m.