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

loveR

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

                                         Write HTML reports for both the enrichment and network analyses
                                         写的HTML的丰富和网络分析报告

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

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

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

When implemented as the method of class GSCA and NWA,  this function produces a report for both the results of Gene Set Collection Analysis and the Network Analysis.
当类方法实现GSCA和NWA，这个函数产生一个基因组收集分析和网络分析的结果的报告。

To use reportAll for objects of class GSCA and NWA:
使用reportAll类的对象GSCA和NWA：

reportAll(gsca, nwa, experimentName="Unknown", species=NULL, ntop=NULL, allSig=FALSE, keggGSCs=NULL, goGSCs=NULL, reportDir="HTSanalyzerReport")
reportAll（gsca，NWA，experimentName =“未知”，种= NULL，则NTOP = NULL，allSig = FALSE时，keggGSCs = NULL，goGSCs = NULL，reportDir =“HTSanalyzerReport”）


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


reportAll(gsca, nwa, ...)



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

参数：gsca
an object of class GSCA (see help(GSCA))  
类对象GSCA（见帮助（GSCA））


参数：nwa
an object of class NWA (see help(NWA))  
一个对象类NWA（见说明（西北航空））


参数：...
other arguments. (see below for the arguments supported by the method of class NWA and GSCA)  
其他参数。 （见下文类NWA和GSCA方法所支持的参数）


Details

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

This function takes 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 and subnetwork figure will be produced in a sub- directory called 'image'. All documents or text files such as the files containing significant gene sets of the hypergeometric 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----------

report, writeReportHTSA
report，writeReportHTSA


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


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

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

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


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