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

loveR

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

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

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

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

This function writes an HTML report following a complete analysis of a data set with the objects of class GSCA and/or NWA.
这个函数写一个HTML报告后，完整的数据分析类GSCA和/或NWA对象。


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


writeReportHTSA(gsca, nwa, experimentName="Unknown", species=NULL,
ntop=NULL, allSig=FALSE, keggGSCs=NULL, goGSCs=NULL, reportDir=
"HTSanalyzerReport")



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

参数：gsca
an object of class GSCA   
一个对象类GSCA


参数：nwa
an object of class NWA  
一个对象类NWA


参数：experimentName
a single character value specifying the name of the experiment (just for you own record)   
一个单一的字符值指定实验名称（只为你自己的纪录）


参数：species
a single character value specifying the species for which the data should be read. The current version supports one of the following species: "Dm" ("Drosophila_melanogaster"), "Hs" ("Homo_sapiens"), "Rn" ("Rattus_ norvegicus"), "Mm" ("Mus_musculus"), "Ce" ("Caenorhabditis_elegans").  
一个单一的字符值，指定读取数据应种。当前版本支持以下种类之一：“DM”（“Drosophila_melanogaster”），“HS”（“Homo_sapiens”），“RN”（“Rattus_家鼠”），“MM”（“ ; Mus_musculus“），”CE“（”Caenorhabditis_elegans）。


参数：ntop
a single integer value specifying the number of plots to be produced for the GSEA analysis. For each gene set collection, plots are produced for the 'ntop' most significant gene sets.   
一个整型值，指定GSEA分析产生的图数量。对于每个基因组的集合，图是“NTOP”最显着的基因组。


参数：allSig
a single logical value determining whether or not to generate plots for all significant gene sets. A gene set is significant if its corresponding adjusted p-value is less than the pValueCutoff set in function analyze.      
一个单一的逻辑值，决定是否产生的所有重大的基因组的图。 A基因组是重要的，如果其相应的调整p值是比pValueCutoff一套功能analyze少。


参数：keggGSCs
a character vector of the names of all KEGG gene set collections. This will help create web links for KEGG terms.   
特征向量的所有的KEGG基因组集合的名称。这将有助于创造为KEGG条款网站链接。


参数：goGSCs
a character vector of the names of all GO gene set collections. This will help create web links for GO terms.   
特征向量的所有GO基因组的集合名称。这将有助于创造好条件的网页链接。


参数：reportDir
a single character value specifying the directory to store reports  
一个单一的字符值，指定的目录来存储报告


Details

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

This function takes in the objects of the two wrapper classes (GSCA and NWA) and writes a report into a user-specified directory. An index HTML file containing a summary of all results and hyperlinked tabs linking 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 the GSEA plots, enrichment maps and 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 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, reportAll
report，reportAll


举例----------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[＃报告同时分析]
writeReportHTSA(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：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。