PomaPCA: Principal Components Analysis

In pcastellanoescuder/POMA_package: Tools for Omics Data Analysis

Principal Components Analysis

Description

PomaPCA performs a principal components analysis on the given SummarizedExperiment object.

Usage

PomaPCA(
  data,
  outcome = NULL,
  center = TRUE,
  scale = TRUE,
  ncomp = 4,
  labels = FALSE,
  ellipse = FALSE,
  load_length = 1
)

Arguments

data	A SummarizedExperiment object.
outcome	Character. Indicates the name of the colData column to be used as the outcome factor. Default is NULL (first factor variable in colData).
center	Logical. Indicates whether the variables should be shifted to be zero centered. Default is TRUE.
scale	Logical. Indicates whether the variables should be scaled to have unit variance before the analysis takes place. Default is TRUE.
ncomp	Numeric. Number of components to be included in the results. Default is 4.
labels	Logical. Indicates if sample names should be displayed.
ellipse	Logical. Indicates whether a 95 percent confidence interval ellipse should be displayed in score plot and biplot. Default is FALSE.
load_length	Numeric. Indicates the length of biplot loading arrows. Value between 1 and 2. Default is 1.

Value

A list with results including plots and tables.

Author(s)

Pol Castellano-Escuder

Examples

data <- POMA::st000336 %>% # Example SummarizedExperiment object included in POMA
  PomaImpute() %>% 
  PomaNorm()

## Output is a list with objects `factors` (tibble wth principal components), `eigenvalues` (tibble), `loadings` (tibble), `factors_plot` (ggplot2 object with PCA plot), `eigenvalues_plot` (ggplot2 object with eigenvalues plot), `loadings_plot` (ggplot2 object), and `biplot` (ggplot2 object)
# Default outcome (first factor variable in `colData`)
data %>%
  PomaPCA(outcome = NULL,
          center = TRUE,
          scale = TRUE,
          labels = FALSE,
          ellipse = FALSE)

# Alternative outcome
data %>%
  PomaPCA(outcome = "steroids",
          center = TRUE,
          scale = TRUE,
          labels = FALSE,
          ellipse = FALSE)

pcastellanoescuder/POMA_package documentation built on Nov. 28, 2024, 1:23 p.m.