WGCNA: newConsensusTree – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

WGCNA

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)

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.

Details

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

Value

A list with class set to "ConsensusTree" with these components: consensusOptionsA copy of the input consensusOptions. inputsA copy of the input inputs. analysisNameA copy of the input analysisName.

Author(s)

Peter Langfelder