computePCAForSamples: Project patients onto existing principal component axes (PCA)

View source: R/processStudy.R

computePCAForSamplesR Documentation

Project patients onto existing principal component axes (PCA)

Description

This function calculates the patient eigenvectors using the specified SNP loadings.

Usage

computePCAForSamples(gds, PATHSAMPLEGDS, listSamples, np = 1L)

Arguments

gds

an object of class SNPRelate::SNPGDSFileClass, a SNP GDS file.

PATHSAMPLEGDS

the path of an object of class gds related to the sample

listSamples

a vector of string representing the samples for which compute the PCA.

np

a single positive integer representing the number of threads. Default: 1L.

Details

More information about the method used to calculate the patient eigenvectors can be found at the Bioconductor SNPRelate website: https://bioconductor.org/packages/SNPRelate/

Value

The integer 0 when successful.

Author(s)

Pascal Belleau, Astrid DeschĂȘnes and Alexander Krasnitz

Examples


## TODO
gds <- "TODO"


belleau/aicsPaper documentation built on Aug. 4, 2022, 1:12 a.m.