bed_scaleBinom: Binomial(2, p) scaling

In bigsnpr: Analysis of Massive SNP Arrays

Binomial(2, p) scaling

Description

Binomial(2, p) scaling where p is estimated.

Usage

bed_scaleBinom(
  obj.bed,
  ind.row = rows_along(obj.bed),
  ind.col = cols_along(obj.bed),
  ncores = 1
)

Arguments

obj.bed	Object of type bed, which is the mapping of some bed file. Use obj.bed <- bed(bedfile) to get this object.
ind.row	An optional vector of the row indices (individuals) that are used. If not specified, all rows are used. Don't use negative indices.
ind.col	An optional vector of the column indices (SNPs) that are used. If not specified, all columns are used. Don't use negative indices.
ncores	Number of cores used. Default doesn't use parallelism. You may use bigstatsr::nb_cores().

Details

You will probably not use this function as is but as parameter fun.scaling of other functions (e.g. bed_autoSVD and bed_randomSVD).

Value

A data frame with ⁠$center⁠ and ⁠$scale⁠.

References

This scaling is widely used for SNP arrays. Patterson N, Price AL, Reich D (2006). Population Structure and Eigenanalysis. PLoS Genet 2(12): e190. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1371/journal.pgen.0020190")}.

Examples

bedfile <- system.file("extdata", "example-missing.bed", package = "bigsnpr")
obj.bed <- bed(bedfile)

str(bed_scaleBinom(obj.bed))

str(bed_randomSVD(obj.bed, bed_scaleBinom))

bigsnpr documentation built on Sept. 30, 2024, 9:18 a.m.