找回密码
 注册
查看: 770|回复: 0

R语言 WGCNA包 mergeCloseModules()函数中文帮助文档(中英文对照)

[复制链接]
发表于 2012-10-1 21:16:36 | 显示全部楼层 |阅读模式
mergeCloseModules(WGCNA)
mergeCloseModules()所属R语言包:WGCNA

                                        Merge close modules in gene expression data
                                         在基因表达数据的合并关闭模块

                                         译者:生物统计家园网 机器人LoveR

描述----------Description----------

Merges modules in gene expression networks that are too close as measured by the correlation of their eigengenes.
合并太接近他们的特征基因的相关性作为衡量的基因表达网络的模块中。


用法----------Usage----------


mergeCloseModules(exprData, colors,
                  consensusQuantile = 0,
                  cutHeight = 0.2,
                  MEs = NULL,
                  impute = TRUE,
                  useAbs = FALSE,
                  corFnc = cor, corOptions = list(use = 'p'),
                  iterate = TRUE,
                  relabel = FALSE,
                  colorSeq = NULL,
                  getNewMEs = TRUE,
                  getNewUnassdME = TRUE,
                  useSets = NULL,
                  checkDataFormat = TRUE,
                  unassdColor = ifelse(is.numeric(colors), 0, "grey"),
                  trapErrors = FALSE,
                  verbose = 1, indent = 0)




参数----------Arguments----------

参数:exprData
Expression data, either a single data frame with rows corresponding to samples and columns to genes, or in a multi-set format (see checkSets). See checkDataStructure below.   
基因表达数据,无论是单一的数据框的行对应于样品和列的基因,或者在一个多设置的格式(见checkSets)。见checkDataStructure下面。


参数:colors
A vector (numeric, character or a factor) giving module colors for genes.  The method only makes sense when genes have the same color label in all sets, hence a single vector.  
一个向量(数字,字符或因素),使模块颜色的基因。该方法只有意义的基因有相同颜色的标签,在所有集合,因此一个向量。


参数:consensusQuantile
A number giving the desired quantile to use in the consensus similarity calculation (see details).
许多得到所需要的位数的的共识相似性计算使用(见详情)。


参数:cutHeight
Maximum dissimilarity (i.e., 1-correlation) that qualifies modules for merging.
最大的差异性(即相关)资格模块的合并。


参数:MEs
If module eigengenes have been calculated before, the user can save some computational time by inputting them. MEs should have the same format as exprData.  If they are not given, they will be calculated.
如果模块特征基因进行了计算之前,用户可以保存输入一些计算时间。 MEs应exprData具有相同的格式。如果它们不给出了,它们将被计算。


参数:impute
Should missing values be imputed in eigengene calculation? If imputation is disabled, the presence of NA entries will cause the eigengene calculation to fail and eigengenes will be replaced by their hubgene approximation. See moduleEigengenes for more details.
如果遗漏值归咎于在eigengene计算的?如果禁用插补,存在的NA项目将导致eigengene的计算,失败和特征基因,取而代之的将是他们的hubgene近似。见moduleEigengenes更多详情。


参数:useAbs
Specifies whether absolute value of correlation or plain correlation (of module eigengenes) should be used in calculating module dissimilarity.
指定的相关性或滑动相关(模块的特征基因)的绝对值是否在计算模块相异时,应使用。


参数:corFnc
Correlation function to be used to calculate correlation of module eigengenes.  
要使用的相关函数计算模块的特征基因的相关性。


参数:corOptions
Can be used to specify options to the correlation function, in addition to argument x which is used to pass the actual data to calculate the correlation of.
可用于指定的相关函数的选项,除了参数x这是用来传递实际数据来计算相关的。


参数:iterate
Controls whether the merging procedure should be repeated until there is no change. If FALSE, only one iteration will be executed.
合并过程的控制是否应重复进行,直到没有任何变化。如果为FALSE,只有一个迭代将被执行。


参数:relabel
Controls whether, after merging, color labels should be ordered by module size.
控制是否合并后,色标,应责令模块的大小。


参数:colorSeq
Color labels to be used for relabeling. Defaults to the standard color order used in this package if colors are not numeric, and to integers starting from 1 if colors is numeric.
颜色的标签被用于重新标记。默认的标准颜色在此包中的命令,如果colors不是数字,整数,从1colors是数字开始。


参数:getNewMEs
Controls whether module eigengenes of merged modules should be calculated and returned.
控制模块特征基因是否应计算并返回合并模块。


参数:getNewUnassdME
When doing module eigengene manipulations, the function does not normally calculate the eigengene of the 'module' of unassigned ('grey') genes. Setting this option to TRUE will force the calculation of the unassigned eigengene in the returned newMEs, but not in the returned oldMEs.
当进行模块eigengene操作,该功能不正常计算的eigengene的“模块”未分配(灰色)的基因。将此选项设置为TRUE将迫使在返回的newMEs的未分配eigengene的计算,但不在返回的oldMEs。


参数:useSets
A vector of scalar allowing the user to specify which sets will be used to calculate the consensus dissimilarity of module eigengenes. Defaults to all given sets.   
允许用户指定哪些集将被用于计算模块的特征基因的共识相异的标量的向量。默认为所有给定的。


参数:checkDataFormat
If TRUE, the function will check exprData and MEs for correct multi-set structure. If single set data is given, it will be converted into a format usable for the function. If FALSE, incorrect structure of input data will trigger an error.
如果为TRUE,该函数将检查exprData和MEs正确的多组结构。如果给出了单一的一套数据,它会被转换成可使用的格式为函数。如有虚假,不正确的输入数据结构,将触发一个错误。


参数:unassdColor
Specifies the string that labels unassigned genes. Module of this color will not enter the module eigengene clustering and will not be merged with other modules.
指定的字符串,标签未分配的基因。这种颜色的模块不会进入的模块eigengene聚类,并不会与其他模块合并。


参数:trapErrors
Controls whether computational errors in calculating module eigengenes, their dissimilarity, and merging trees should be trapped. If TRUE, errors will be trapped and the function will return the input colors. If FALSE, errors will cause the function to stop.
控制是否应该被困在计算模块的特征基因,他们的差异性,以及合并树的计算错误。如果TRUE,错误将被捕获,该函数将返回输入的颜色。如果FALSE,错误会导致停止的功能。


参数:verbose
Controls verbosity of printed progress messages. 0 means silent, up to (about) 5 the verbosity gradually increases.
控制冗长的印刷进度消息。 0表示沉默,同比增长约5的详细程度逐渐增加。


参数:indent
A single non-negative integer controlling indentation of printed messages. 0 means no indentation, each unit above that adds two spaces.  
一个单一的非负整数控制缩进印刷信息。 0表示无压痕,上述各单位,增加了两个空间。


Details

详细信息----------Details----------

This function returns the color labels for modules that are obtained from the input modules by merging ones that are closely related. The relationships are quantified by correlations of module eigengenes; a “consensus” measure is defined as the “consensus quantile”  over the corresponding relationship in each set. Once the (dis-)similarity is calculated, average linkage hierarchical clustering of the module eigengenes is performed, the dendrogram is cut at the height cutHeight and modules on each branch are merged. The process is (optionally) repeated until no more modules are merged.
这个函数返回的颜色标签的模块,输入模块的合并是密切相关的。量化模块的特征基因的相关性的关系;“共识”措施被定义为在每个集合中的对应关系的“共识位数”。一旦(显示)计算相似度,平均连锁层次聚类进行模块的特征基因的,树状图的高度处被切断cutHeight和模块,每个分支上合并。该过程(任选)重复进行,直到没有更多的模块被合并。

If, for a particular module, the module eigengene calculation fails, a hubgene approximation will be used.
如果,对于一个特定的模块,模块eigengene计算失败,一个hubgene近似将被使用。

The user should be aware that if a computational error occurs and trapErrors==TRUE,  the returned list (see below) will not contain all of the components returned upon normal execution.
用户应该知道,如果出现计算错误,trapErrors==TRUE,在返回的列表(见下文)不会包含所有的组件时返回正常执行。


值----------Value----------

If no errors occurred, a list with components
如果没有发生错误,与组件的列表


参数:colors
Color labels for the genes corresponding to merged modules. The function attempts to mimic the mode of the input colors: if the input colors is numeric, character and factor, respectively, so is the output. Note, however, that if the fnction performs relabeling, a standard sequence of labels will be used: integers starting at 1 if the input colors is numeric, and a sequence of color labels otherwise (see colorSeq above).
合并模块对应的基因的颜色标签。该函数试图模仿的输入colors:如果输入colors是数字,字符和因子,分别,所以是输出的模式。然而,请注意,如果的fnction进行重新标记,一个标准的序列的标签将被使用:整数,从1开始,如果,输入colors是数字的,和一个序列的颜色标签,否则(见colorSeq上述)。


参数:dendro
Hierarchical clustering dendrogram (average linkage) of the eigengenes of the most recently computed tree. If iterate was set TRUE, this will be the dendrogram of the merged modules, otherwise it will be the dendrogram of the original modules.
最近计算的特征基因树的层次聚类树状图(平均连接)。如果iterate设置为TRUE,这将是聚类分析中的合并模块,否则这将是原来的模块的树状图。


参数:oldDendro
Hierarchical clustering dendrogram (average linkage) of the eigengenes of the original modules.
原来的模块的特征基因的层次聚类树形图(平均连锁)。


参数:cutHeight
The input cutHeight.
输入cutHeight。


参数:oldMEs
Module eigengenes of the original modules in the sets given by useSets.
模块特征基因的原始模块中套的useSets。


参数:newMEs
Module eigengenes of the merged modules in the sets given by useSets.
模块特征基因的useSets套的合并模块。


参数:allOK
A boolean set to TRUE.
一个布尔值设置为TRUE。

If an error occurred and trapErrors==TRUE, the list only contains these components:
如果出现错误和trapErrors==TRUE,列表中只包含以下组件:


参数:colors
A copy of the input colors.
输入颜色的副本。


参数:allOK
a boolean set to FALSE.
一个布尔值设置为FALSE。


(作者)----------Author(s)----------



Peter Langfelder, <a href="mailtoeter.Langfelder@gmail.com">eter.Langfelder@gmail.com</a>


转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注:
注1:为了方便大家学习,本文档为生物统计家园网机器人LoveR翻译而成,仅供个人R语言学习参考使用,生物统计家园保留版权。
注2:由于是机器人自动翻译,难免有不准确之处,使用时仔细对照中、英文内容进行反复理解,可以帮助R语言的学习。
注3:如遇到不准确之处,请在本贴的后面进行回帖,我们会逐渐进行修订。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|生物统计家园 网站价格

GMT+8, 2024-11-25 05:30 , Processed in 0.020267 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表