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

loveR

geneAnswersBuilder(GeneAnswers)
geneAnswersBuilder()所属R语言包：GeneAnswers

                                         Build an object of a GeneAnswers class
                                         建立一个一个GeneAnswers类的对象

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

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

A function to build an object of a GeneAnswers class based on given information.
函数来建立一个对象上所提供的信息为基础的GeneAnswers类。


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


geneAnswersBuilder(geneInput, annotationLib, categoryType = NULL, testType = c("hyperG", "none"), known=TRUE, totalGeneNumber=NULL, geneExpressionProfile = NULL, categorySubsetIDs = NULL, pvalueT = 0.01, FDR.correction = FALSE, verbose=TRUE, sortBy=c('pvalue', 'geneNum', 'foldChange', 'oddsRatio', 'correctedPvalue', 'none'), ...)



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

参数：geneInput
a dataframe containing gene IDs and possible values associated with given gene IDs.  
1 dataframe含有基因ID和与特定基因的ID相关联的可能值。


参数：annotationLib
name of given annotation library file or user provided annotation list.  
注释库文件或用户名称提供了注解列表。


参数：categoryType
name of given annotation category or NULL for user provided annotation list.  
名称标注类别或NULL为用户提供了注解列表。


参数：testType
name of enrichment test.  
浓缩试验的名称。


参数：known
logic, specify only known annotation gene enrichment test.  
逻辑，指定唯一已知的注释基因的富集试验。


参数：totalGeneNumber
number of total genes to perform hypergeometric test.  
基因总数的执行超几何试验。


参数：geneExpressionProfile
data frame containing gene expression file or NULL.  
数据框包含的基因表达的文件或NULL。


参数：categorySubsetIDs
a character vector of user-specified subset of categories to be tested.  
一个用户指定要测试的类的子集的特征向量。


参数：pvalueT
p-value threshold of the enrichment test.  
p值阈值的浓缩试验。


参数：FDR.correction
logic, indicating if FDR correction of the enrichment test p-value is performed or not.  
逻辑，如果FDR的铀浓缩试验的p值校正执行或不。


参数：verbose
logic, display current building stage.  
逻辑，显示当前的建设阶段。


参数：sortBy
sorted type   
排序类型


参数：...
additional arguments passed to getGOList.  
额外的参数传递到getGOList。


Details

详情----------Details----------

As the input of geneAnswersBuilder, geneInput could be a character vector (Gene Entrez ID vector), a matrix or a dataframe. For the matrix and dataframe, the first column is for Gene Entrez IDs, while other columns could be any interested values that could be used to represent gene expression direction for generating concepts-genes network. Rownames are not necessary.
作为输入geneAnswersBuilder的，geneInput可能是字符向量（基因Entrez的ID向量），矩阵或1 dataframe的。对于矩阵和dataframe，第一列是基因的Entrez的ID，而其他列可以是任何产生概念的基因网络基因表达的方向，可以用来表示有兴趣的值。没有必要rownames。

annotationLib could be Disease Ontology library, Entrez annotation libraries for a specie, such as 'org.Hs.eg.db'. Current version supports "org.Ag.eg.db", "org.Bt.eg.db", "org.Ce.eg.db", "org.Cf.eg.db", "org.Dm.eg.db", "org.Dr.eg.db", "org.EcK12.eg.db", "org.EcSakai.eg.db", "org.Gg.eg.db", "org.Hs.eg.db", "org.Mm.eg.db", "org.Mmu.eg.db", "org.Pt.eg.db", "org.Rn.eg.db", "org.Ss.eg.db", "org.Xl.eg.db", "org.At.tair.db", "org.Pf.plasmo.db" and "org.Sc.sgd.db". User can also use own annotation library. User's annotation library should be a list. Each element in this list is a vector of genes for a user-specified category. Names of this annotation list are categories' names.
annotationLib可能是疾病本体库，一个物种的Entrez的注释库如“org.Hs.eg.db的。当前版本支持“org.Ag.eg.db”，“org.Bt.eg.db”，“org.Ce.eg.db”，“org.Cf.eg.db”，“ORG Dm.eg.db“，”org.Dr.eg.db“，”org.EcK12.eg.db“，”org.EcSakai.eg.db“，”org.Gg.eg.db“ “org.Hs.eg.db”，“org.Mm.eg.db”，“org.Mmu.eg.db”，“org.Pt.eg.db”，“ORG。 rn.eg.db“，”org.Ss.eg.db“，”org.Xl.eg.db“，”org.At.tair.db“，”org.Pf.plasmo.db“和“org.Sc.sgd.db”。用户还可以使用自己注解库。用户的注释库应该是一个列表。在此列表中的每个元素是一个为用户指定的类基因的向量。这个注释列表的名称是类的名字。

categoryType could be "GO", "GO.BP", "GO.CC", "GO.MF", "DOLITE", "KEGG", "REACTOME.PATH" and "CABIO.PATH". "GO.BP" only test biological process Gene Ontology terms, "GO.CC" for cellular components, "GO.MF" for molecular functions, "GO" for all of these three categories, "KEGG" for all KEGG pathways, and "REACTOME.PATH" for all REACTOME pathways, "caBIO.PATH" for NCI-Nature  curated, Biocarta and REACTOME, which might not work with all available Entrez annotation libraries, please refer getTotalGeneNumber for details. For user provided annotation library, it should be NULL in most cases.
可能是categoryType“GO”，“GO.BP”，“GO.CC”，“GO.MF”，“DOLITE”，“KEGG”，“REACTOME.PATH”和“CABIO。路径“。 “GO.BP”只测试生物过程的基因本体论方面，蜂窝组件的“GO.CC”，“GO.MF”分子功能，所有这三类的“GO”，“KEGG” KEGG通路，，“REACTOME.PATH”所有REACTOME途径，的“caBIO.PATH”NCI自然策划，Biocarta和REACTOME，可能无法正常工作Entrez的所有可用的注释库，请参阅getTotalGeneNumber有关详细信息。为用户提供的注释库，它在大多数情况下应为NULL。

If known is set to TRUE, the enrichment test only considers the genes with annotation. If FALSE, the total number of genes in that species will be returned. If user has own annotationLib, totalGeneNumber should be an integer, or one of "anopheles", "arabidopsis", "bovine", "worm", "canine", "fly", "zebrafish", "ecolistraink12", "ecolistrainsakai", "chicken", "human", "mouse", "rhesus", "malaria", "chimp", "rat", "yeast", "pig" and "xenopus". NULL only works when "known" is set TRUE. geneAnswersBuilder will automatically assign the corresponding value to totalGeneNumber. User can get total gene numbers by getTotalGeneNumber, too.
如果已知被设置为TRUE，浓缩试验只考虑与注释的基因。如果为FALSE，该物种的基因总数将被退回。如果用户有自己的annotationLib，totalGeneNumber应该是一个整数，或“按蚊”，“拟南芥”，“牛”，“蠕虫”，“犬”，“飞”，“斑马鱼”， “ecolistraink12”，“ecolistrainsakai”，“鸡”，“人类”，“老鼠”，“猴”，“疟疾”，“黑猩猩”，“鼠”，“酵母” “猪”和“爪”。 NULL只能当“称为”被设置为TRUE。 geneAnswersBuilder会自动分配到相应的值totalGeneNumber。用户可以通过getTotalGeneNumber总基因数，也。

sortBy could be one of "geneNum", "pvalue", "foldChange", "oddsRatio", "correctedPvalue" and "none". Default value is 'pvalue'.
sortBy，可能“geneNum”之一，的“pvalue”，“foldChange”，“oddsRatio”，“correctedPvalue”和“无”。默认值是pvalue“。


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

A GeneAnswers class containing geneInput, entrichmentInfo, etc.
包含一个GeneAnswers类geneInput，entrichmentInfo等。


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


Gang Feng,  Pan Du and Simon Lin



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

<h3>See Also</h3>

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


data('humanExpr')
data('humanGeneInput')
x <- geneAnswersBuilder(humanGeneInput, 'org.Hs.eg.db', categoryType='GO.BP', testType='h', pvalueT=0.1, FDR.correct=TRUE, geneExpressionProfile=humanExpr)
class(x)

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


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