R语言 genefu包 subtype.cluster()函数中文帮助文档(中英文对照)

loveR

subtype.cluster(genefu)
subtype.cluster()所属R语言包：genefu

                                         Function to fit the Subtype Clustering Model
                                         功能，以适应亚型聚类分析模型

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

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

This function fits the Subtype Clustering Model as published in Desmedt et al. 2008 and Wiarapati et al. 2008. This model is actually a mixture of three Gaussians with equal shape, volume and variance (see EEI model in Mclust). This model is adapted to breast cancer and uses ESR1, ERBB2 and AURKA dimensions to identify the molecular subtypes, i.e. ER-/HER2-, HER2+ and ER+/HER2- (Low and High Prolif).
此功能符合亚型聚类分析模型的，作为发表在Desmedt等。 2008年和Wiarapati等。 2008年。这种模式实际上是一个三高斯与同等形状，体积和方差（见EEI在Mclust模型）的混合物。这种模式适用于乳腺癌和使用ESR1，ERBB2和AURKA尺寸来确定分子亚型，即ER-/HER2-中，HER2 + ER + / HER-2（低和高增殖）。


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


subtype.cluster(module.ESR1, module.ERBB2, module.AURKA, data, annot,
  do.mapping = FALSE, mapping, do.scale = TRUE, rescale.q = 0.05,
  model.name = "EEI", do.BIC = FALSE, plot = FALSE, filen, verbose = FALSE)



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

参数：module.ESR1
Matrix containing the ESR1-related gene(s) in rows and at least three columns: "probe", "EntrezGene.ID" and "coefficient" standing for the name of the probe, the NCBI Entrez Gene id and the coefficient giving the direction and the strength of the association of each gene in the gene list.  
行和至少三列矩阵包含的的ESR1相关基因（S）：“探针”，“EntrezGene.ID”和“系数”为探针，在NCBI Entrez基因ID名称的地位和系数给人的方向和强度的基因列表中的每个基因的关联。


参数：module.ERBB2
Idem for ERBB2.  
同上为ERBB2的。


参数：module.AURKA
Idem for AURKA.  
同上为AURKA。


参数：data
Matrix of gene expressions with samples in rows and probes in columns, dimnames being properly defined.  
矩阵中的行和列的探针样品的基因表达，dimnames被正确定义。


参数：annot
Matrix of annotations with at least one column named "EntrezGene.ID", dimnames being properly defined.  
矩阵至少有一列名为“EntrezGene.ID”的注释，dimnames被正确定义。


参数：do.mapping
TRUE if the mapping through Entrez Gene ids must be performed (in case of ambiguities, the most variant probe is kept for each gene), FALSE otherwise.  
TRUE如果通过Entrez基因ID的映射必须执行（含糊不清的情况下，每个基因保存最变种探针），FALSE否则。


参数：mapping
Matrix with columns "EntrezGene.ID" and "probe" used to force the mapping such that the probes are not selected based on  their variance.  
列“EntrezGene.ID”和“探针”使用强制映射探针没有被选中，根据其方差矩阵。


参数：do.scale
TRUE if the ESR1, ERBB2 and AURKA (module) scores must be rescaled (see rescale), FALSE otherwise.  
TRUE如果ESR1，ErbB2和AURKA（模块）的成绩必须重新调整（见rescale）FALSE否则。


参数：rescale.q
Proportion of expected outliers for rescaling the gene expressions.  
重新调整基因表达的预期离群的比例。


参数：do.BIC
TRUE if the Bayesian Information Criterion must be computed for number of clusters ranging from 1 to 10, FALSE otherwise.  
TRUE如果必须为数字聚类从1到10不等，FALSE否则计算贝叶斯信息准则。


参数：model.name
Name of the model used to fit the mixture of Gaussians with the Mclust from the mclust package; default is "EEI" for fitting a mixture of Gaussians with diagonal variance, equal volume, equal shape and identical orientation.  
使用适合从mclust包Mclust的混合高斯模型，默认是“协作计划”对角线差异，同等体积，同等形状和相同的方向拟合的高斯混合的名称。


参数：plot
TRUE if the patients and their corresponding subtypes must be plotted, FALSE otherwise.  
TRUE如果病人及其相应的亚型，必须绘制，FALSE否则。


参数：filen
Name of the csv file where the subtype clustering model must be stored.  
csv文件必须存储亚型聚类分析模型的名称。


参数：verbose
TRUE to print informative messages, FALSE otherwise.  
TRUE打印翔实的消息，FALSE否则。


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


参数：model
Subtype Clustering Model (mixture of three Gaussians), like scmgene.robust, scmod1.robust and scmod2.robust when this function is used on expO dataset (International Genomics Consortium) with the gene modules published in the two references cited below.
亚型聚类分析模型（3高斯混合），像scmgene.robust，scmod1.robust和scmod2.robust使用此功能时，博览集（国际基因组学联盟）在两个引用公布的基因模块下面引用。


参数：BIC
Bayesian Information Criterion for the Subtype Clustering Model with number of clusters ranging from 1 to 10.
贝叶斯信息标准的数字聚类从1到10的亚型聚类分析模型。


参数：subtype
Subtypes identified by the Subtype Clustering Model. Subtypes can be either "ER-/HER2-", "HER2+" or "ER+/HER2-".
亚型鉴定亚型聚类分析模型。亚型或者“ER-/HER2-”，“的HER2 +”或“ER阳性/ HER-2”。


参数：subtype.proba
Probabilities to belong to each subtype estimated by the Subtype Clustering Model.
概率属于由亚型聚类模型估计每个亚型。


参数：subtype2
Subtypes identified by the Subtype Clustering Model using AURKA to discriminate low and high proliferative tumors. Subtypes can be either "ER-/HER2-", "HER2+", "ER+/HER2- High Prolif" or "ER+/HER2- Low Prolif".
亚型鉴定亚型聚类模型使用AURKA区分高，低增生性肿瘤。亚型可无论是“ER-/HER2-”的HER2 +“，”ER阳性/ HER-2高增殖“或”ER / HER-2低增殖“。


参数：subtype.proba2
Probabilities to belong to each subtype (including discrimination between lowly and highly proliferative ER+/HER2- tumors, see subtype2) estimated by the Subtype Clustering Model.
概率属于每个亚型（包括卑微和高度增殖ER + / HER-2的肿瘤之间的歧视，看到subtype2）亚型聚类分析模型的估计。


参数：module.scores
Matrix containing ESR1, ERBB2 and AURKA module scores.
矩阵包含ESR1，ErbB2和AURKA模块分数。


作者（S）----------Author(s)----------



Benjamin Haibe-Kains




参考文献----------References----------




参见----------See Also----------

subtype.cluster.predict, intrinsic.cluster,  intrinsic.cluster.predict, scmod1.robust, scmod2.robust
subtype.cluster.predict，intrinsic.cluster，intrinsic.cluster.predict，scmod1.robust，scmod2.robust


举例----------Examples----------


## example without gene mapping[＃例如没有基因图谱]
## load expO data[＃载入世博会的数据]
data(expos)
## load gene modules[＃加载基因模块。]
data(mod1)
## fit a Subtype Clustering Model[＃适合亚型聚类分析模型]
scmod1.expos <- subtype.cluster(module.ESR1=mod1$ESR1, module.ERBB2=mod1$ERBB2,
  module.AURKA=mod1$AURKA, data=data.expos, annot=annot.expos, do.mapping=FALSE,
  do.scale=TRUE, plot=TRUE, verbose=TRUE)
str(scmod1.expos, max.level=1)
table(scmod1.expos$subtype2)

## example with gene mapping[＃例如基因图谱]
## load NKI data[＃负载NKI日经指数数据]
data(nkis)
## load gene modules[＃加载基因模块。]
data(mod1)
## fit a Subtype Clustering Model[＃适合亚型聚类分析模型]
scmod1.nkis <- subtype.cluster(module.ESR1=mod1$ESR1, module.ERBB2=mod1$ERBB2,
  module.AURKA=mod1$AURKA, data=data.nkis, annot=annot.nkis, do.mapping=TRUE,
  do.scale=TRUE, plot=TRUE, verbose=TRUE)
str(scmod1.nkis, max.level=1)
table(scmod1.nkis$subtype2)

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


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