get.signatures: Get features from a SPEARobject.

View source: R/2_helpers.R

get.signaturesR Documentation

Get features from a SPEARobject.

Description

Get features from a SPEARobject.

Usage

get.signatures(
  rank = "probability",
  factors = NULL,
  assays = NULL,
  coefficient.cutoff = 0,
  probability.cutoff = 0.95,
  correlation = "none"
)

Arguments

rank

How to rank features? Defaults to '"probability"' (joint.probability) followed by projection.coefficient. Can also be "'coefficient'" (only projection.coefficient magnitude).

factors

Which factors to return signatures for? Accepts integers (i.e. 'factors = c(1,2,4)' or 'factors = 1') Defaults to 'NULL' (all).

assays

Which assays? Check names via 'names(SPEAR$data$train)'. Defaults to 'NULL' (all)

coefficient.cutoff

What projection.coefficient value to use as the cutoff? Defaults to 0

probability.cutoff

What joint.probability value to use as the cutoff? Defaults to .95

correlation

Return columns with factor score correlations? Accepts '"spearman"', '"pearson"', '"kendall"', or "'none'" (default)


jgygi/SPEAR documentation built on July 5, 2023, 5:35 p.m.