calc_umap: Generate 2D cell embeddings using UMAP

Description Usage Arguments Value

View source: R/dims.R

Description

See https://umap-learn.readthedocs.io for a detailed description of parameters.

Usage

1
2
3
calc_umap(fce, expt = "sce", method = "PCA", n_dims = NULL,
  n_neighbors = 30, min_dist = 0.3, metric = "euclidean",
  seed = NA, ...)

Arguments

fce

fce object

expt

Data to use for UMAP, one of either sce (rna data, the default) or fsce (functional data)

method

dimenality reduction method to use for UMAP, defaults to PCA

n_dims

number of dimensions to pass to UMAP, defaults to all present in dr matrix

n_neighbors

number of nearest neighbors to use for learning the manifold. Low values will preserve local structure, at the expense missing higher order organization. Higher values will capture more global structure but miss fine grained detail. Defaults to 30.

min_dist

Numeric between 0 and 0.99. min_dist controls how tightly points can be packed together in 2D space. Lower values will generate more clumpy projections, but more accurately preserve local structure.

metric

distance metric for UMAP, defaults to pearson.

seed

seed to generate reproducible UMAP projection. Defaults to no seed.

...

additional arguments for umap::umap()

Value

fce object with UMAP values added to reducedDims


hesselberthlab/scrunchy documentation built on Dec. 7, 2018, 7:55 a.m.