getHclustObj: Obtain the original clustering objects

In theMILOlab/cypro: A Toolbox for Analysis of Single Cell Microscopy Data

Obtain the original clustering objects

Description

These functions extract the resulting objects of the respective algorithms calculated with the respective methods denoted by the method_*-arguments.

Usage

getHclustObj(
  object,
  variable_set,
  phase = NULL,
  method_dist = NULL,
  method_aggl = NULL
)

Arguments

object	A valid cypro object.
variable_set	Character value. Denotes the variable set of interest. Use getVariableSetNames() to obtain all names of currently stored variable sets in your object.
phase	Character or numeric. If character, the ordinal value referring to the phase of interest (e.g. 'first', 'second' etc.). referring to the phase of interest or 'all'. If numeric, the number referring to the phase. If set to NULL takes the phase denoted as default with adjustDefault(). Ignored if the experiment design contains only one phase.
method_dist	Character vector (or value see details for more.) Denotes the distance method(s) of interest (e.g. 'euclidean' or 'manhattan'). Use validDistanceMethods() to obtain all valid input options.
method_aggl	Character vector (or value see details for more.) Denotes the agglomeration method(s) of interest according to which the existing distance matrices are agglomerated to hierarchical trees. Use validAgglomerationMethods() to obtain all valid input options.

Details

In this case all method_*-arguments must be specified as character values as the objects are returned one by one.

Value

The respective clustering results as their original objects.

theMILOlab/cypro documentation built on April 5, 2022, 2:03 a.m.