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

loveR

reportAnnotation(RNAinteract)
reportAnnotation()所属R语言包：RNAinteract

                                        Specialized report functions
                                         专门报告功能

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

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

Functions that provide a html report of genetic interactions screens for specific topics.
功能，提供了一个特定主题的遗传相互作用屏幕的HTML报告。


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


reportAnnotation        (sgi, verbose = 0, path = ".", dir = "annotation",
                         prefix = "annotation", report = NULL)
reportStatistics        (sgi, verbose = 0, path = ".", dir = "stats",
                         prefix = "stat", report = NULL)
reportGeneLists         (sgi, verbose = 0, path = ".", dir = "hitlist",
                         prefix = "hitlist", report = NULL)
reportNetworks          (sgi, verbose = 0, path = ".", dir = "networks",
                         prefix = "networks", Networks, qv = 0.05,
                         withoutgroups = c("pos", "neg"), report = NULL)
reportScreenData        (sgi, type = "data", design = "template",
                         do.trafo = TRUE, do.inv.trafo = FALSE, verbose = 0,
                         path = ".", dir = "screenplots", prefix = "screenplot",
                         png.args = list(width = 960, height = 960),
                         pdf.args = list(width = 7, height = 7),
                         plotScreen.args = list(ncol = 6L, do.legend = TRUE,
                                                fill = c("red", "white", "blue")),
                         png.scatter.args = list(width = 400, height = 400),
                         pdf.scatter.args = list(width = 7, height = 7), report = NULL)
reportDoublePerturbation(sgi, verbose = 0, path = ".", dir = "doublePerturbations",
                         prefix = "doublePerturbationPlots", report = NULL,
                         withoutgroups = c("neg", "pos"),
                         png.args = list(width = 500, height = 500),
                         pdf.args = list(width = 7, height = 7), ...)
reportMainEffects       (sgi, verbose = 0, path = ".", dir = "maineffects",
                         prefix = "maineffects",
                         png.args = list(width = 500, height = 500),       
                         pdf.args = list(width = 7, height = 7),
                         plot.args = list(), report = NULL)
reportHeatmap           (sgi, verbose = 0, path = ".", dir = "heatmap",
                         prefix = "heatmap",
                         png.args = list(width = 1000, height = 1000),
                         pdf.args = list(width = 15, height = 15),
                         report = NULL, withoutgroups = c("neg", "pos"))



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

参数：sgi
An object of class RNAinteract.
对象类RNAinteract。


参数：verbose
Either 0 (default, no output), 1 (minimum output), or 2 (outout)
0（默认情况下，没有输出），1（最小输出）或2（outout）


参数：path
The main path to the HTML report directory.
HTML报告目录的主要途径。


参数：dir
A subdirectory where the report is written to.
一个书面报告子目录。


参数：prefix
A prefix for each file written in the subdirectory. Using different prefixes, one can write multiple reports in the same directory.
写在子目录中的每个文件的前缀。使用不同的前缀，可以写在同一目录中的多个报告。


参数：report
A report object as generated by startReport.
startReport生成报表对象。


参数：Networks
A boolean array with edges from interaction graphs.
布尔数组与互动图表的边缘。


参数：qv
A cut-off value for the q-values.
一个Q值的临界值。


参数：withoutgroups
Genes annotated with these groups are not plotted in this report.
本报告中不绘制基因注释与这些团体。


参数：type
Any "type" that can be passed to getData.
任何“类型”，可以通过getData。


参数：design
Either "template" (default) or "query"
无论是“模板”（默认）或“查询”

Apply the (inverse) transformation before plotting.
申请前图（逆）转化。


参数：png.args
A list with entries width and height specifying the width and height of the generated png images.
一个列表项的宽度和指定生成PNG图像的宽度和高度的高度。


参数：pdf.args
A list with entries width and height specifying the width and height of the generated of files.
一个条目的宽度和高度的列表，指定生成的文件的宽度和高度。


参数：plotScreen.args
Arguments for the screen plots
参数的屏幕图

Arguments for the scatter plots
参数为的散点图


参数：...
Parameters passed to the plotting functions.
参数传递给绘图功能。


Details

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

Each of these function generates a HTML report. It is added to a HTML frame.
这些函数都生成一个HTML报告。它被添加到一个HTML框架。

The report object has to be created with startReport beforehand. Multiple report functions can be called afterwards. When all reports are written, the report is finalized and closed by endReport.
报告对象要事先与startReport创造。可以称为事后多个报表功能。书面报告时，报告定稿，并关闭endReport。


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

All functions return a report object as returned by startReport.
所有函数返回一个报表对象由startReport返回。


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



Bernd Fischer




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

RNAinteract-package, startReport, endReport
RNAinteract-package，startReport，endReport


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


data("sgi")
report = startReport("report")
reportAnnotation(sgi, report = report)
endReport(report)
# browseURL(file.path("report","index.html"))[browseURL（file.path（“报告”，为“index.html”））]

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


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