perform.pca: Performs PCA reduction

Description Usage Arguments Value Examples

View source: R/perform.pca.R

Description

Performs PCA reduction on defined method-assays. Data should be HVG subset, normalised and scaled (in the norm.scaled assay)

Usage

1
2
3
4
5
6
7
8
9
perform.pca(
  object,
  assay,
  slot = "norm.scaled",
  n.pcs = 50,
  reduction.save = "pca",
  save.plot = TRUE,
  ...
)

Arguments

object

IBRAP S4 class object

assay

Character. String containing indicating which assay to use

slot

Character. String indicating which slot within the assay should be sourced

n.pcs

Numerical. How many principal components should be produced. Default = 50

reduction.save

Character. What should this reduction be saved as in computation_reduction. Default = 'pca'

...

Arguments to be passed to PCAtools::pca

Value

PCA reductions contained within the computational_reduction list in the defined assays

Examples

1
2
3
4
object <- perform.pca(object = object, 
                      assay = c('SCT', 'SCRAN', 'SCANPY'), 
                      n.pcs = 50, 
                      reduction.save = 'pca')

connorhknight/IBRAP_no_decontX documentation built on Feb. 13, 2022, 2:32 p.m.