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

loveR

htmlReport(R453Plus1Toolbox)
htmlReport()所属R语言包：R453Plus1Toolbox

                                        HTML-Report Builder for the AVASet and MapperSet
                                         HTML的报表生成器的AVASet和MapperSet

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

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

This function creates a HTML variant and quality report for a given AVASet or MapperSet instance.
这个函数创建一个HTML的变种和质量报告一个给定的AVASet或MapperSet实例。


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


htmlReport(object, annot, blocks=c(), transcripts=c(), sampleCols, minMut=3, dir="HTMLReport", title="Summary")



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

参数：object
An AVASet-class or MapperSet-class instance.
AVASet-class或MapperSet-class实例。


参数：annot
An instance of class AnnotatedVariants you get by calling annotateVariants.  If no such argument is supplied the data will be read from the Ensembl database automatically for all variants.
AnnotatedVariants调用annotateVariants类的一个实例。如果没有这样的说法提供的数据将被读取从Ensembl的数据库自动为所有变种。


参数：blocks
Character vector of block names for each variant. The variants will then be structured into several blocks. If no such list is  supplied, the report consists of just one (big) table for all variants.
块名称为每个变种的特征向量。变种然后将结构分为若干块。如果没有这样的名单提供，该报告只是一个（大）所有型号的表组成。


参数：transcripts
Character vector containing Ensembl transcript-IDs that order the according entries on the transcript pages. Transcripts given in this argument will appear on top of the transcript page.
特征向量包含Ensembl的成绩单，标识，以便谈话页面上根据作品。这种说法中的成绩单将出现在谈话页的顶部。


参数：sampleCols
Character vector of column names of the sample data (phenoData) of the AVASet/MapperSet object to filter the sample output  on the transcript pages. All columns will be listed if no such argument is given.
特征向量过滤谈话页上的示例输出的AVASet / MapperSet对象（phenoData）样本数据的列名。如果没有这样的参数，将列出所有列。


参数：minMut
If the value of minMut is greater than zero, the report lists only variants, whose coverage for at least one sample is higher than minMut (percentage between 0 and 100).
如果的minMut值大于零，该报告列出了唯一的变种，至少有一个样本的覆盖面比minMut（0和100之间的百分比）。


参数：dir
Character with the desired output directory. By defaultm the directory "HTMLReport" will be created in the current directory.
性格与所需的输出目录。由defaultm目录“HTMLReport”将在当前目录中创建。


参数：title
Heading for the first page with the variant information.
变异信息的第一页的标题。


Details

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

The report is structured into two (MapperSet) or three (AVASet) parts containing variant and quality information:
该报告的结构含变种和高质量的信息分为两个（MapperSet）或三（AVASet）的部分：

The main page sums up given variant information like the name, type, reference gene, position (see fData, annotateVariants). <br> Using the argument blocks, the main page can be individually  structured by assigning a block name to each variant. <br> The main page can be further structured by samples. For a given AVASet object, every sample links to another short quality report showing only the amplicon coverage for this sample.
主页总结起来好像是这个名字的变异信息，类型，参照基因的位置（见fData，annotateVariants）。参考使用参数blocks，主要页面可以单独结构分配块的名称，每个变种。参考的主要页面可以进一步样品结构。为某一AVASet对象，每个样品链接到另一个短质量报告显示，仅此范例扩增覆盖。

Every variant on the main page links to a page with further details about the affected genes and transcripts (e.g. Ensembl gene-IDs, transcript-IDs, codon sequences, changes of amino acids (if coding)).
每个主要页面链接到页进一步的细节与有关受影响的基因和转录（如Ensembl的基因身份证，成绩单，身份证，密码子序列，氨基酸的变化（如编码））的变种。

Only in case of AVASet object: A quality report shows the coverage of every amplicon in forward and/or reverse direction. Further plots display the coverage by MID and PTP (if this information is given in the pheno data of the object).
只有在情况AVASet对象：质量报告显示，每一个在前锋和/或反向扩增的覆盖面。进一步图显示中旬和PTP（如果这个信息是在给定对象的苯酚数据）的覆盖面。


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


Christoph Bartenhagen, Hans-Ulrich Klein, Christian Ruckert



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

annotateVariants.
annotateVariants。


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


# note: all examples save the report to the directory "htmlReportExample" in your current R working directory[注：所有的例子将报表保存到目录“htmlReportExample”在当前R工作目录]

# load a filtered AVA dataset containing 6 samples, 4 amplicons and 4 variants[装入一个过滤的AVA的数据集，包含6个样品，4扩增和4变种]
# and its variant annotations[其变种注解]
data("avaSetFiltered")
data("avaSetFiltered_annot")

# create a full report showing all (unfiltered) information[创建一个完整的报告显示，所有（未筛选）信息]
htmlReport(avaSetFiltered, avaSetFiltered_annot, dir="htmlReportExample", title="htmlReport Example", minMut=0)
# create a report that emphasizes on samples with variants covered by at least 50% of the reads [创建一个报告强调与覆盖至少50％的读取的变种样本]
htmlReport(avaSetFiltered, avaSetFiltered_annot, dir="htmlReportExample", title="htmlReport Example", minMut=50)

# create a report that is structured by the reference genes[创建一个参照基因结构的报告]
library("ShortRead")
refs = sapply(fData(avaSetFiltered)$referenceSeq, function(x)
    subset(pData(alignData(referenceSequences(avaSetFiltered))), pData(alignData(referenceSequences(avaSetFiltered)))$refSeqID == x)$name)
htmlReport(avaSetFiltered, avaSetFiltered_annot, dir="htmlReportExample", title="htmlReport Example", minMut=0, blocks=refs)

# create a report whose sample information only lists the sample ids[创建一个报告，其样本资料仅列出了样品ID]
pData(avaSetFiltered)
sampleCols = "SampleID"
htmlReport(avaSetFiltered, avaSetFiltered_annot, dir="htmlReportExample", title="htmlReport Example", minMut=0, sampleCols=sampleCols)

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


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