ClusterFunction-methods: Helper methods for the ClusterFunction class

In epurdom/clusterExperiment: Compare Clusterings for Single-Cell Sequencing

Helper methods for the ClusterFunction class

Description

This is a collection of helper methods for the ClusterExperiment class.

Usage

## S4 method for signature 'character'
requiredArgs(object)

## S4 method for signature 'ClusterFunction'
requiredArgs(object, genericOnly = FALSE)

## S4 method for signature 'list'
requiredArgs(object)

## S4 method for signature 'character'
requiredArgs(object)

## S4 method for signature 'character'
requiredArgs(object)

## S4 method for signature 'factor'
requiredArgs(object)

## S4 method for signature 'ClusterFunction'
algorithmType(object)

## S4 method for signature 'character'
algorithmType(object)

## S4 method for signature 'factor'
algorithmType(object)

## S4 method for signature 'list'
algorithmType(object)

## S4 method for signature 'ClusterFunction'
inputType(object)

## S4 method for signature 'list'
inputType(object)

## S4 method for signature 'character'
inputType(object)

## S4 method for signature 'factor'
inputType(object)

Arguments

object	input to the method, either a ClusterFunction class or a character describing a built-in ClusterFunction object. Can also be a list of ClusterFunction objects, in which case the list must have names for each function.
genericOnly	logical If TRUE, return only the generic required arguments (i.e. those required by the algorithm type) and not the arguments specific to that clustering found in the slot requiredArgs. If FALSE both sets of arguments are returned.

Details

Note that when subsetting the data, the dendrogram information and the co-clustering matrix are lost.

Value

requiredArgs returns a list of the required args of a function (via a call to requiredArgs)

algorithmType returns a character value giving the type of clustering function ("01" or "K")

inputType returns a character value giving the input type of the object

epurdom/clusterExperiment documentation built on April 23, 2024, 9:09 p.m.