discardDistanceMatrix: Discard calculated distance matrix

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

Discard calculated distance matrix

Description

Allows to discard distance matrices that have been already used by agglomerateHierarchicalCluster(). (Distance matrices are usually objects of several hundred megabytes.) Once discarded it can not be used any longer but can be calculated again via computeDistanceMatrix().

Usage

discardDistanceMatrix(
  object,
  variable_set,
  phase = NULL,
  method_dist = NULL,
  verbose = 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.
verbose	Logical. If set to TRUE informative messages regarding the computational progress will be printed. (Warning messages will always be printed.)

Details

Distance matrices are discarded one by one. Input for argument method_dist must be a single character value.

Value

An updated version of the input cypro-object.

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