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

loveR

PROMISE(PROMISE)
PROMISE()所属R语言包：PROMISE

                                         PRojection onto the Most Interesting Statistical Evidence
                                         投影到最有趣的统计证据

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

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

Perform permutation-based test to identify genes with expression levels having a specific biologically interesting pattern of associations with multiple endpoint variables
执行排列为基础的测试，以确定基因的表达水平有多个终点变量与特定的生物有趣的协会模式


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


PROMISE(exprSet, geneSet=NULL, promise.pattern, strat.var=NULL, seed=13,
        nperms=10000)



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

参数：exprSet
an ExpressionSet class contains minimum of exprs (expression matrix) and phenoData (AnnotatedDataFrame of end point data).  Please refer to Biobase for details on how to create such an ExpressionSet.
ExpressionSet类包含exprs（表达矩阵）和phenoData（终点数据AnnotatedDataFrame）的最低。请指BIOBASE详细介绍如何创建这样一个ExpressionSet。


参数：geneSet
a GeneSetCollection class with minimum of setName and geneIDs for each GeneSet.  Please refer to GSEABase for how to create such a GeneSetCollection class. The default is NULL which will perform no gene set enrichment analysis.   
为每个GeneSet setName和geneIDs的最低GeneSetCollection类。请参照，以GSEABase如何创建这种GeneSetCollection类的。预设值是NULL，这将不执行基因组富集分析。


参数：promise.pattern
a data frame defining the association pattern of interest. The column names must be stat.coef, stat.func, and endpt.vars. The stat.coef column gives the coefficients for combining the statistics of association of genomic variable with individual endpoint variable into the ultimate PROMISE statistic.  The stat.func column gives the name of the R routine that computes the test statistic of association of the endpoint variables. Two R routines (jung.rstat and spearman.rstat)are provided. Users can provide their own routine accordingly.  The endpt.vars column gives the name(s) of variable(s) in the endpoint data file needed to compute each term of  the PROMISE statistic. A common without a space should be used to separate multiple variables that correspond to the same term in the association pattern definition.   
一个数据框，定义所关注的关联模式。列名必须是stat.coef，stat.func，和endpt.vars的。 stat.coef列给出了组合成最终的承诺统计关联的基因组与个别端点变量变量统计系数。 stat.func列给出的R常规计算端点变量测试协会统计的名称。两个R例程（jung.rstat和spearman.rstat）提供。用户可以提供自己的常规。 endpt.vars列给变量的名称（S）（S）在端点数据文件需要计算每一个术语的承诺统计。应使用一个没有共同空间分隔多个变量对应的协会模式的定义相同期限。


参数：strat.var
the name or numeric value of variable in the stratum variable in exprSet for stratified analysis. The default is NULL which performs an unstratified analysis.  
分层分析地层在exprSet的变量，变量的名称或数值。默认值为NULL，执行不分层分析。


参数：seed
initial seed random number generator. The default is 13.
最初的种子随机数发生器。默认是13。


参数：nperms
number of permutations. The default is 10,000.
排列数。默认值是10,000。


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


参数：$generes
individual genes' test statistics and p-values for each individual endpoint  and PROMISE analysis.  
单个基因的检验统计量和p值，为每个端点，并承诺分析。


参数：$setres
gene set's test statistics and p-values for each individual endpoint  and PROMISE analysis. If geneSet is NULL, the value of this component is also NULL.   
基因组的测试统计，并为每个端点，并承诺分析p值。如果geneSet是NULL，该组件的值也为NULL。


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



Stan Pounds <a href="mailto:stanley.pounds@stjude.org">stanley.pounds@stjude.org</a>; Xueyuan Cao <a href="mailto:xueyuan.cao@stjude.org">xueyuan.cao@stjude.org</a>




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

PROMISE: a tool to identify genomic features with a specific biologically interesting pattern of associations  with multiple endpoint variables. Bioinformatics 25: 2013-2019

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

jung.rstat avg.abs.genestat  promise.genestat  spearman.rstat promise.pattern
jung.rstatavg.abs.genestatpromise.genestatspearman.rstatpromise.pattern


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


## load sampExprSet, sampGeneSet, phPatt.[＃加载sampExprSet，sampGeneSet，phPatt。]
data(sampExprSet)
data(sampGeneSet)
data(phPatt)

## Perform PROMISE procedure without GSEA[＃执行承诺没有GSEA程序]
test1 <- PROMISE(exprSet=sampExprSet,
                 geneSet=NULL,
                 promise.pattern=phPatt,
                 strat.var=NULL,
                 seed=13,
                 nperms=10)
            
## Perform PROMISE procedure with GSEA             [＃执行承诺与GSEA程序]
res <- PROMISE(exprSet=sampExprSet,
               geneSet=sampGeneSet,
               promise.pattern=phPatt,
               strat.var=NULL,
               seed=13,
               nperms=10)

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


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