BIC)

WGCNA_coexprNetwork

R Documentation

WGCNA main function.

Description

WGCNA main function.

Usage

WGCNA_coexprNetwork(
  datExpr,
  power,
  maxBlockSize = NULL,
  minModuleSize = NULL,
  networkType = "signed",
  mergeCutHeight = 0.2,
  numericLabels = TRUE,
  pamRespectsDendro = FALSE,
  saveTOMs = TRUE,
  corType = "bicor",
  maxPOutliers = NULL,
  loadTOM = TRUE,
  TOMDenom = "min",
  deepSplit = 1,
  stabilityCriterion = "Individual fraction",
  saveTOMFileBase = "blockwiseTOM",
  verbose = 3,
  randomSeed = 1117,
  saveplot = NULL,
  width = 14,
  height = 7,
  noplot = FALSE,
  dynamicCutPlot = TRUE,
  ...
)

Arguments

`datExpr`	Expression data. A matrix (preferred) or data frame in which columns are genes and rows ar samples. NAs are allowed, but not too many. See `checkMissingData` below and details.
`power`	soft-thresholding power for network construction.
`maxBlockSize`	integer giving maximum block size for module detection. Ignored if `blocks` above is non-NULL. Otherwise, if the number of genes in `datExpr` exceeds `maxBlockSize`, genes will be pre-clustered into blocks whose size should not exceed `maxBlockSize`.
`minModuleSize`	minimum module size for module detection. See `cutreeDynamic` for more details.
`networkType`	network type. Allowed values are (unique abbreviations of) `"unsigned"`, `"signed"`, `"signed hybrid"`. See `adjacency`.
`mergeCutHeight`	dendrogram cut height for module merging.
`numericLabels`	logical: should the returned modules be labeled by colors (`FALSE`), or by numbers (`TRUE`)?
`pamRespectsDendro`	Logical, only used when `pamStage` is `TRUE`. If `TRUE`, the PAM stage will respect the dendrogram in the sense an object can be PAM-assigned only to clusters that lie below it on the branch that the object is merged into. See `cutreeDynamic` for more details.
`saveTOMs`	logical: should the consensus topological overlap matrices for each block be saved and returned?
`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.
`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.
`loadTOM`	logical: should Topological Overlap Matrices be loaded from previously saved files (`TRUE`) or calculated (`FALSE`)? It may be useful to load previously saved TOM matrices if these have been calculated previously, since TOM calculation is often the most computationally expensive part of network construction and module identification. See `saveTOMs` and `saveTOMFileBase` below for when and how TOM files are saved, and what the file names are. If `loadTOM` is `TRUE` but the files cannot be found, or do not contain the correct TOM data, TOM will be recalculated.
`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.
`deepSplit`	integer value between 0 and 4. Provides a simplified control over how sensitive module detection should be to module splitting, with 0 least and 4 most sensitive. See `cutreeDynamic` for more details.
`stabilityCriterion`	One of `c("Individual fraction", "Common fraction")`, indicating which method for assessing stability similarity of two branches should be used. We recommend `"Individual fraction"` which appears to perform better; the `"Common fraction"` method is provided for backward compatibility since it was the (only) method available prior to WGCNA version 1.60.
`saveTOMFileBase`	character string containing the file name base for files containing the consensus topological overlaps. The full file names have `"block.1.RData"`, `"block.2.RData"` etc. appended. These files are standard R data files and can be loaded using the `load` function.
`verbose`	integer level of verbosity. Zero means silent, higher values make the output progressively more and more verbose.
`randomSeed`	integer to be used as seed for the random number generator before the function starts. If a current seed exists, it is saved and restored upon exit. If `NULL` is given, the function will not save and restore the seed.
`saveplot`	Save plot to given file "a.pdf", "b.png".
`width`	Width of graphics in inches. Default 14.
`height`	Height of graphics in inches. Default 7.
`noplot`	Return construccted net object only.
`dynamicCutPlot`	Plot merged modules as well as dynamic cutted modules before merge.
`...`	Other parameters given to `blockwiseModules`.

Value

A network

Explanations

maxBlockSize: Maximum allowed number of genes in one block. Default "all genes in one block". Please check http://www.peterlangfelder.com/blockwise-network-analysis-of-large-data/ for more explanations. Analyzing a set of 20,000 genes requires between 8 and 16 GB of memory; 40,000 genes would increase the requirement to 32-64 GB. A full network analysis of 500,000 genes would theoretically require some 7 TB of memory.

Quote: I emphasize that the blockwise analysis creates an approximation to the network that would result from a single block analysis. The approximation is often very good but the modules are not quite the same. If possible, I recommend running the analysis in a single block; if not, use the largest blocks your computer can handle.

mergeCutHeight The larger the less number of merged modules. Normally 0.15-0.3.
networkType: "signed" is recommended. However, number of genes in modules would also be less for "signed" netwrok. Check WGCNA_softpower for the detail.
corType: biweight mid-correlation (bicor) recommended.

Examples


df = generateAbundanceDF(nSample=30, nGrp=3, sd=5)
datExpr <- WGCNA_dataFilter(df)
datExpr <- WGCNA_sampleClusterDetectOutlier(datExpr)
power <- WGCNA_softpower(datExpr)
net <- WGCNA_coexprNetwork(datExpr, power)

#2
exprMat <- "test.file"
wgcnaL <- WGCNA_readindata(exprMat)

traitData <- 'trait.file'
wgcnaL <- WGCNA_readindata(exprMat, traitData)
datExpr <- wgcnaL$datExpr
WGCNA_dataCheck(datExpr)
datExpr <- WGCNA_dataFilter(datExpr)
datExpr <- WGCNA_sampleClusterDetectOutlier(datExpr)
# datExpr <- WGCNA_sampleClusterDetectOutlier(datExpr, traitColors=wgcnaL$traitColors)
power <- WGCNA_softpower(datExpr)
net <- WGCNA_coexprNetwork(datExpr, power)

Tong-Chen/ImageGP documentation built on April 14, 2025, 12:54 p.m.