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

loveR

chrHeatMap(ChromHeatMap)
chrHeatMap()所属R语言包：ChromHeatMap

                                         Plot ChrStrandMatrix objects as heat maps along a chromosome
                                         图ChrStrandMatrix对象沿着染色体的热图

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

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

Plots a either one or two ChrStrandMatrix objects (typically constructed using the createChrMatrix function) as heat maps along a specified chromosome, optionally clustering samples and including an idiogram.
图1一个或两个ChrStrandMatrix对象（通常使用createChrMatrix函数构造）沿着指定染色体的热图，可选聚类样本和包括idiogram的，。


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


chrHeatMap (strand.data, cytopaint.func=NULL, col = "heat.colors",
            start, end, breaks, RowSideColors, title=TRUE,
            margins = c(6, 6), cexCyto = 0.8, srtCyto=90, lmat = NULL, lhei = NULL,
            lwid = NULL, ...)



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

参数：strand.data
A ChrStrandMatrix object, or a list of such objects, one per strand to be plotted (or a single matrix for "both" strands), created using the createChrMatrix function.
一个ChrStrandMatrix对象或这些对象的列表，每串被绘制（或单一矩阵为双方股），使用createChrMatrix函数创建。


参数：cytopaint.func
A function closure taking a single argument, "boxwidth", and plotting its enclosed idiogram data at that width. See plotChrMap for the code used to generate this closure.
函数关闭一个参数，“boxwidth”，并绘制的宽度其封闭idiogram数据。见plotChrMap用于生成这个封闭的代码。


参数：col
A vector of colors to use for the heat map, or the name of a function generating such a vector.
颜色的向量使用热图，或生成一个向量的函数的名称。


参数：start
The starting genome coordinate for the plot.
起始基因组协调的图。


参数：end
The ending genome coordinate for the plot.
截至基因组协调的图。


参数：breaks
A vector of numeric break points indicating the boundaries between the col colors.
一个向量表示col颜色之间的边界的数字突破点。


参数：RowSideColors
A vector of colors to use for a color band indicating e.g. sample categories.
一个向量使用的颜色，例如带颜色样本类别。


参数：title
If TRUE, this causes the function to include default heat map subtitles indicating which chromosome and strand has been plotted. If FALSE or NULL, subtitles will left blank. If this argument is set to a character vector of the same length and order as strand.data its contents will be used as heat map subtitles.
如果为TRUE，这将导致包括默认的热图字幕显示染色体和钢绞线已绘制的功能。如果为FALSE或NULL，字幕会留下空白。如果此参数设置为一个相同的长度和顺序为strand.data特征向量，其内容将被用作热图字幕。


参数：margins
A numeric vector indicating the c(bottom, left) margins of the plot containing X and Y axes labels.
一个数字矢量显示的C（上下，左右）的图利润率含有X和Y轴的标签。


参数：cexCyto
A positive number used to control the font size for the idiogram plot. For plots spanning just a few cytobands it may be worth setting this to a larger number, and srtCyto, below, to zero.
一个正数，用来控制字体大小为idiogram图。为跨越短短cytobands的图，它可能是值得设置一个更大的数字，和srtCyto，低于零。


参数：srtCyto
A number indicating the degree to which the idiogram text labels should be rotated. This defaults to 90 degrees, but for more detailed plots a setting of zero here often looks better.
数字表明，的idiogram文本标签应旋转的程度。至90度，但更详细的图的零这里设置这个默认常常看起来更好。


参数：lmat
An optional matrix to be passed to layout.
可选矩阵通过layout的。


参数：lhei
An optional vector of layout row heights.
一个layout行高度可选向量。


参数：lwid
An optional vector of layout row widths.
一个layout行的宽度可选向量。


参数：...
Additional arguments are passed to the drawMapDendro function.
额外的参数传递给drawMapDendro功能。


Details

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

Typically this function should not be called directly, but rather via the wrapper plotChrMap function. This function uses cytoband data from the UCSC genome annotation database and code adapted from the quantsmooth package to draw an idiogram of the chromosome, or a  subset thereof.
通常这个功能不应该被直接调用，而是通过包装plotChrMap函数。使用此功能从UCSC基因组注释数据库和适应从quantsmooth包的代码绘制一个染色体idiogram的，或其中的一个子集cytoband数据。


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

This function is executed for its side effects.
这个函数执行它的副作用。


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


Tim F Rayner



参考文献----------References----------

<h3>See Also</h3>   <code>plotChrMap</code>, <code>createChrMatrix</code>, <code>drawMapDendro</code>

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


data('demo')
stranddata <- createChrMatrix( chrdata, chr=22, strand='forward', start=21925000, end=24300000 )
chrHeatMap(stranddata)

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


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