fcdr_dimred: Perform Dimension Reduction

Description Usage Arguments Value Examples

View source: R/fc_dim_red.R

Description

Function for doing multiple kinds of dimension reduction.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
fcdr_dimred(
  fc,
  method,
  dims = NULL,
  perplexity = 30,
  init_pca = TRUE,
  max_iters = 500,
  theta = 0.5,
  seed = 1337,
  verbose = FALSE
)

Arguments

fc

The Fc Array data frame

method

A string "pca", "tsne", or "umap" the denotes what dimension reduction method will be used.

dims

The number of dimensions to reduce the dataset down to. Pass NULL if you want all components back (PCA), or if you feel like letting tSNE and UMAP yell at you that they picked 2 for you.

perplexity

A parameter for tSNE. It will be adjusted for you if you don't provide it/change it and it needs providing/to be changed.

init_pca

A boolean that determines whether or not tSNE performs an initial pca to perform a first-pass on reducing dimensions.

max_iters

The maximum number of iterations you want tSNE or UMAP to perform before terminating.

theta

Speed/accuracy tradeoff for tSNE. 0.0 is exact tSNE, 1.0 is "just get it done ASAP idfc if it's wildly inaccurate".

seed

The random seed you wish to use to facilitate reproducibility.

verbose

A boolean that determines how much you get yelled at by tSNE and UMAP about how they're doing.

Value

The Fc Array data frame with all the features replaced by all the components generated by the method you used.

Examples

1
2
3
4
5
colnames(fc)
# [1] "subject" "group" "IgG3.gp41" "IgG.gp70.V1.V2" # etc.
fc_tsne = fcdr_dimred(fc, "tsne", dims=2)
colnames(fc_tsne)
# [1] "subject" "group" "tsne.1" "tsne.2"

kmorrisongr/fcan documentation built on Sept. 9, 2020, 10:12 a.m.