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

loveR

report(HTSanalyzeR)
report()所属R语言包：HTSanalyzeR

                                         Write HTML reports for enrichment or network analyses
                                         写的HTML浓缩或网络分析报告

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

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

This is a generic function.
这是一个通用的功能。

When implemented as the method of class GSCA or NWA,  this function produces reports for either the Gene Set Collection  Analysis or the Network Analysis.
当类方法实现GSCA或NWA，这个函数产生的基因组收集分析或网络分析报告。

To use report for objects of class GSCA or NWA:
使用report类的对象GSCA或NWA：

report(object, experimentName="Unknown", species=NULL, ntop=NULL, allSig=FALSE, keggGSCs=NULL, goGSCs=NULL, reportDir="HTSanalyzerReport")
报告（对象，experimentName =“未知”，物种= NULL，则NTOP = NULL，allSig = FALSE时，keggGSCs = NULL，goGSCs = NULL，reportDir =“HTSanalyzerReport”）


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


report(object, ...)



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

参数：object
an object. When implemented as S4 methods of class GSCA or NWA, this  argument is either an object of class GSCA or NWA.  
一个对象。当为S4类方法实现GSCA或NWA，这种说法是一个类的对象GSCA或NWA。


参数：...
other arguments. (see below for the arguments supported by the method of class GSCA or NWA)  
其他参数。 （见下面的方法类GSCA或NWA支持的论据）


Details

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

This function take in the objects of the two wrapper classes (GSCA  and NWA) and writes a report into the user-specified directory. An index HTML file containing a summary of all results and hyperlinked  tabs to more detailed results will be generated in the root directory.  The other HTML files will be stored in a subdirectory called 'html'. All  images including GSEA plots, enrichment maps and the subnetwork figure  will be produced in a subdirectory called 'image'. All documents or text  files such as the files containing significant gene sets of the hyper- geometric test results will be stored in a subdirectory called 'doc'.
此功能在两个包装类的对象（GSCA和NWA），并写入到用户指定的目录一份报告。索引HTML文件，其中包含了所有结果的总结和超链接标签更详细的结果将在根目录下生成。其他的HTML文件将被保存在一个子目录名为“HTML”。所有图像，包括的GSEA图，丰富图和子网图，会产生所谓的“形象”的子目录。所有的文件或包含超几何测试结果显着的基因集的文件，如文本文件将被存储在一个子目录名为“DOC”。


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



Xin Wang, Camille Terfve




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

reportAll, writeReportHTSA
reportAll，writeReportHTSA


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


## Not run: [＃无法运行：]
##(see the vignette for details about the preprocessing of this data set)[（看到这组数据的预处理插曲）]
library(KEGG.db)
library(GO.db)
library(AnnotationDbi)
##report for a GSCA object[＃GSCA对象的报告]
data("KcViab_GSCA")
##append gene set terms to results[＃追加基因组方面成果]
KcViab_GSCA<-appendGSTerms(KcViab_GSCA, keggGSCs="PW_KEGG",
goGSCs=c("GO_BP","GO_MF","GO_CC"))
report(object=KcViab_GSCA, experimentName="KcViab", species="Dm",
allSig=TRUE, keggGSCs="PW_KEGG", goGSCs=c("GO_BP","GO_MF","GO_CC"),
reportDir="HTSanalyzerGSCAReport")
browseURL(file.path(getwd(), "HTSanalyzerGSCAReport", "index.html"))
##report for a NWA object[＃报告为NWA对象]
data("KcViab_NWA")       
report(object=KcViab_NWA, experimentName="KcViab", species="Dm",
allSig=TRUE, keggGSCs="PW_KEGG", goGSCs=c("GO_BP","GO_MF","GO_CC"),
reportDir="HTSanalyzerNWReport")
browseURL(file.path(getwd(), "HTSanalyzerNWReport", "index.html"))

## End(Not run)[＃结束（不运行）]

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


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