Learn R Programming

WGCNA (version 1.73)

newConsensusTree: Create a new consensus tree

Description

This function creates a new consensus tree, a class for representing "recipes" for hierarchical consensus calculations.

Usage

newConsensusTree(
   consensusOptions = newConsensusOptions(), 
   inputs, 
   analysisName = NULL)

Value

A list with class set to "ConsensusTree" with these components:

consensusOptions

A copy of the input consensusOptions.

inputs

A copy of the input inputs.

analysisName

A copy of the input analysisName.

Arguments

consensusOptions

An object of class ConsensusOptions, usually obtained by calling newConsensusOptions.

inputs

A vector (or list) of inputs. Each component can be either a character string giving a names of a data set, or another ConsensusTree object.

analysisName

Optional specification of a name for this consensus analysis. While this has no effect on the actual consensus calculation, some functions use this character string to make certain file names unique.

Author

Peter Langfelder

Details

Consensus trees specify a "recipe" for the calculation of hierarchical consensus in hierarchicalConsensusCalculation and other functions.

See Also

hierarchicalConsensusCalculation for hierarchical consensus calculation for which a ConsensusTree object specifies the recipe