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

loveR

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

                                         Generate a multigroup Concepts-genes analysis report
                                         生成多种群概念基因的分析报告

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

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

Function to generate a html format top multigroup Concepts-genes analysis report based on a given GeneAnswers instance list.
函数生成一个HTML格式的顶级多组概念基因的分析报告的基础上GeneAnswers实例列表。


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


groupReport(dataMatrix, gAList, topCat=10, methodOfCluster=c('mds', 'sort'), matrixOfHeatmap=NULL, clusterTable=c('geneNum', 'pvalue', NULL), catTerm=TRUE,
                fileName = "multiConceptsGenes.html", title='Multigroup Genes Concepts Analysis', catType=c('GO', 'KEGG', 'DOLITE', 'REACTOME.PATH', 'CABIO.PATH', 'Unknown'),
                reverseOfCluster=FALSE,  colorValueColumn = NULL, annLib=c('org.Hs.eg.db', 'org.Rn.eg.db', 'org.Mm.eg.db', 'org.Dm.eg.db'), nameLength=94, addID=TRUE, interactive=FALSE,



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

参数：dataMatrix
a top concepts-genes matrix generated by getConceptTable.  
顶级概念基因矩阵生成getConceptTable。


参数：gAList
a GeneAnswers instance list.   
1 GeneAnswers实例列表。


参数：topCat
number to specify how many top concepts-genes analysis will show.  
将显示指定多少概念基因分析。


参数：methodOfCluster
cluster method
聚类方法


参数：matrixOfHeatmap
NULL or a concepts-genes matrix generated by getConceptTable, which is used to show enrichment test significance for each concept.  
NULL或由的getConceptTable，这是用来显示每个概念的铀浓缩试验的意义产生了一份概念，基因矩阵。


参数：clusterTable
cluster data to specify which type of values will be used for cluster.  
指定哪种类型的值将使用聚类的聚类数据。


参数：catTerm
logic, determine whether mapping category IDs to names
逻辑，确定是否映射的类别ID名称


参数：fileName
output html file name  
输出HTML文件的名称


参数：title
output html title  
输出HTML标题


参数：catType
category type, current version supports 'GO', 'KEGG', 'DOLITE', 'REACTOME.PATH', 'CABIO.PATH' and customized annotation libraries, 'Unknown'.  
类别类型，当前版本支持GO，KEGG“，”DOLITE，REACTOME.PATH，CABIO.PATH和定制注解库，“未知”。


参数：reverseOfCluster
logic, whether reverse the cluster order.  
逻辑，是否聚类为了扭转。


参数：colorValueColumn
numbers or column names of geneInput slots of the given GeneAnswers instance list to specify the colors of leaves  
号码或给予GeneAnswers实例列表geneInput插槽列名指定的颜色，树叶


参数：annLib
annotation librarry names, current version supports 'org.Hs.eg.db', 'org.Rn.eg.db', 'org.Mm.eg.db' and 'org.Dm.eg.db'.  
的注解librarry名称，当前版本支持org.Hs.eg.db，org.Rn.eg.db，org.Mm.eg.db和org.Dm.eg.db。


参数：nameLength
show how many first letters for long term names, 'all' for full name, default value is 94.  
显示术语的名字多少的第一个字母，“所有”的全名，默认值是94。


参数：addID
logic, add term IDs following term names or not
逻辑，加上术语的ID后，术语的名称或不


参数：interactive
logic, determine whether network is interactive or not. Interactive network requires java and flash supports.  
逻辑，确定是否是互动的，或网络。交互式网络需要支持Java和Flash。


参数：bgColor
a R compatible color for html background color.
一个R兼容的HTML背景颜色的颜色。


参数：keepCytoscapeFiles
logic, determine whether to keep cytoscape files if interactive is set to TRUE
逻辑，确定是否保留Cytoscape的文件，如果交互式设置为TRUE


参数：...
other parameters used by 'sort'  
其他参数使用“排序”


Details

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

In general, a html format top multigroup Concepts-genes analysis report is generated. It includes a multigroup concepts-genes table, several concepts-genes networks figures and a couple of tables containing genes and their information. colorValueColumn could be NULL, column name or a same length column-name vector as length of the given GeneAnswers instantce list. No color for genes if it is NULL. All of GeneAnswers instances are applied color for genes based on the same column name if the length is one. Or the colors of genes in concepts-genes networks are based on the same length column-name vector.  If catType is not set to 'Unknown', catTerm in function getConceptTable should be set to FALSE.
在一般情况下，会生成一个HTML格式的顶部多组概念基因分析报告。它包括多种群的概念基因的表，有几个概念的基因网络数字和几个含有基因和他们的信息表。 colorValueColumn可能是NULL，列名或一个相同长度的列名的向量作为给予GeneAnswers instantce列表的长度。没有颜色的基因，如果它是NULL。 GeneAnswers实例应用的颜色，如果长度是一个基于相同的列名的基因。基于相同长度的列名的向量或基因概念基因网络的颜色。如果没有设置为“未知”，在功能getConceptTable catTerm catType应设置为FALSE。


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

no value returned
没有返回值


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


Gang Feng, Pan Du and Simon Lin



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

<h3>See Also</h3>

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


data(sampleGroupsData)
gAKEGGL <- lapply(sampleGroupsData, geneAnswersBuilder, 'org.Hs.eg.db', categoryType='KEGG', pvalueT=0.1, verbose=FALSE)
output<- getConceptTable(gAKEGGL, catTerm=FALSE, items='geneNum')
groupReport(output[[1]], gAKEGGL,  matrixOfHeatmap=output[[2]], clusterTable=NULL, fileName='KEGGtest.html',  catType='KEGG', colorValueColumn=colnames(sampleGroupsData[[1]])[-1])

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


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