clusterDiscovrExperiment: Perform phenograph clustering for a DISCOV-R experiment

View source: R/clusteringPhase.R

clusterDiscovrExperimentR Documentation

Perform phenograph clustering for a DISCOV-R experiment

Description

Perform phenograph clustering for a DISCOV-R experiment

Usage

clusterDiscovrExperiment(
  experiment,
  method = "phenograph",
  k = 30,
  seed = 12345,
  verbose = TRUE
)

Arguments

experiment

A discovrExperiment created using setupDiscovrExperiment()

method

A character string indicating the clustering method to use. Currently only 'phenograph' is supported as a clustering method.

k

An integer specifying the maximum number of nearest neighbors to use. Applies only if method = 'phenograph' (default: 30)

seed

A number to be used as the seed for pseudorandom number generation (default: 12345)

verbose

A boolean specifying whether to display processing messages (default: TRUE)

Value

An S3 object of class discovrExperiment

Author(s)

Mario G Rosasco, Virginia Muir

See Also

setupDiscovrExperiment discovrExperiment


BenaroyaResearch/briDiscovr documentation built on March 15, 2024, 12:31 a.m.