TOMsimilarityFromExpr: Topological overlap matrix
In nosarcasm/WGCNA: Weighted Correlation Network Analysis

Description Usage Arguments Value Author(s) References See Also

Calculation of the topological overlap matrix from given expression data.

TOMsimilarityFromExpr(
  datExpr, 
  weights = NULL,
  corType = "pearson", 
  networkType = "unsigned", 
  power = 6, 
  TOMType = "signed", 
  TOMDenom = "min",
  maxPOutliers = 1,
  quickCor = 0,
  pearsonFallback = "individual",
  cosineCorrelation = FALSE, 
  replaceMissingAdjacencies = FALSE,
  suppressTOMForZeroAdjacencies = FALSE,
  useInternalMatrixAlgebra = FALSE,
  nThreads = 0,
  verbose = 1, indent = 0)

`datExpr`	expression data. A data frame in which columns are genes and rows ar samples. NAs are allowed, but not too many.
`weights`	optional observation weights for `datExpr` to be used in correlation calculation. A matrix of the same dimensions as `datExpr`, containing non-negative weights.
`corType`	character string specifying the correlation to be used. Allowed values are (unique abbreviations of) `"pearson"` and `"bicor"`, corresponding to Pearson and bidweight midcorrelation, respectively. Missing values are handled using the `pairwise.complete.obs` option.
`networkType`	network type. Allowed values are (unique abbreviations of) `"unsigned"`, `"signed"`, `"signed hybrid"`. See `adjacency`.
`power`	soft-thresholding power for netwoek construction.
`TOMType`	one of `"none"`, `"unsigned"`, `"signed"`. If `"none"`, adjacency will be used for clustering. If `"unsigned"`, the standard TOM will be used (more generally, TOM function will receive the adjacency as input). If `"signed"`, TOM will keep track of the sign of correlations between neighbors.
`TOMDenom`	a character string specifying the TOM variant to be used. Recognized values are `"min"` giving the standard TOM described in Zhang and Horvath (2005), and `"mean"` in which the `min` function in the denominator is replaced by `mean`. The `"mean"` may produce better results but at this time should be considered experimental.

`maxPOutliers`	only used for `corType=="bicor"`. Specifies the maximum percentile of data that can be considered outliers on either side of the median separately. For each side of the median, if higher percentile than `maxPOutliers` is considered an outlier by the weight function based on `9*mad(x)`, the width of the weight function is increased such that the percentile of outliers on that side of the median equals `maxPOutliers`. Using `maxPOutliers=1` will effectively disable all weight function broadening; using `maxPOutliers=0` will give results that are quite similar (but not equal to) Pearson correlation.
`quickCor`	real number between 0 and 1 that controls the handling of missing data in the calculation of correlations. See details.
`pearsonFallback`	Specifies whether the bicor calculation, if used, should revert to Pearson when median absolute deviation (mad) is zero. Recongnized values are (abbreviations of) `"none", "individual", "all"`. If set to `"none"`, zero mad will result in `NA` for the corresponding correlation. If set to `"individual"`, Pearson calculation will be used only for columns that have zero mad. If set to `"all"`, the presence of a single zero mad will cause the whole variable to be treated in Pearson correlation manner (as if the corresponding `robust` option was set to `FALSE`). Has no effect for Pearson correlation. See `bicor`.
`cosineCorrelation`	logical: should the cosine version of the correlation calculation be used? The cosine calculation differs from the standard one in that it does not subtract the mean.
`replaceMissingAdjacencies`	logical: should missing values in the calculation of adjacency be replaced by 0?
`suppressTOMForZeroAdjacencies`	Logical: should TOM be set to zero for zero adjacencies?
`useInternalMatrixAlgebra`	Logical: should WGCNA's own, slow, matrix multiplication be used instead of R-wide BLAS? Only useful for debugging.
`nThreads`	non-negative integer specifying the number of parallel threads to be used by certain parts of correlation calculations. This option only has an effect on systems on which a POSIX thread library is available (which currently includes Linux and Mac OSX, but excludes Windows). If zero, the number of online processors will be used if it can be determined dynamically, otherwise correlation calculations will use 2 threads.
`verbose`	integer level of verbosity. Zero means silent, higher values make the output progressively more and more verbose.
`indent`	indentation for diagnostic messages. Zero means no indentation, each unit adds two spaces.

A matrix holding the topological overlap.

Peter Langfelder

Bin Zhang and Steve Horvath (2005) "A General Framework for Weighted Gene Co-Expression Network Analysis", Statistical Applications in Genetics and Molecular Biology: Vol. 4: No. 1, Article 17

TOMsimilarity

nosarcasm/WGCNA documentation built on May 28, 2019, 1:01 p.m.