找回密码
 注册
查看: 316|回复: 0

R语言 rsgcc包 gcc.tsheatmap()函数中文帮助文档(中英文对照)

[复制链接]
发表于 2012-9-28 21:54:05 | 显示全部楼层 |阅读模式
gcc.tsheatmap(rsgcc)
gcc.tsheatmap()所属R语言包:rsgcc

                                         correlaiton and clustering analysis of tissue-specific genes
                                         correlaiton和组织特异性基因的聚类分析

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

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

This function performs the correlaiton and clustering analysis of tissue-specific genes with expression data generated from microarray and RNA-Seq experiments.
这个函数执行correlaiton和聚类分析的组织特异性基因表达产生的微阵列和RNA-Seq的实验数据。


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


gcc.tsheatmap(x,
                           
      cpus = 1,
                        
      ## correlation method
      cormethod = c("GCC", "PCC", "SCC", "KCC", "BiWt"),
                          
      distancemethod = c("Raw", "Abs", "Sqr"),
                           
      #cluster method
      clustermethod = c("complete", "average", "median",
                        "centroid", "mcquitty", "single", "ward"),
                        
      #hcdata by output gcc.tsheatmap
      rowhcdata = NULL,
      colhcdata = NULL,   
                          
                          
      keynote = "FPKM",
                        
      ## dendrogram control
      symm = FALSE,
                     
      ## data scaling
      scale = c("none","row", "column"),
      na.rm=TRUE,

      ## image plot
      revC = identical(Colv, "Rowv"),
      add.expr,

      ## mapping data to colors
      breaks,
      symbreaks=min(x < 0, na.rm=TRUE) || scale!="none",

      ## colors
      colrange = c("yellow", "red"),
                          
      tissuecol= "heat.colors",

      ## block sepration
      colsep = 0.15,
      rowsep,
      sepcolor="white",
      sepwidth=c(0.05,0.05),
         
      ## level trace
      trace=c("none","column","row","both"),
      tracecol="cyan",
      hline=median(breaks),
      vline=median(breaks),
      linecol=tracecol,

      ## plot margins
      margins = c(5, 5),

      ## plot labels
      main = NULL,
      xlab = NULL,
      ylab = NULL,

      ## plot layout
      lmat = NULL,
      lhei = NULL,
      lwid = NULL,

      ## extras
      ...)



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

参数:x
a data matrix containing numeric variables. Example: rows may correspond to genes and columns to samples.   
数据矩阵包含数字的变量。实施例:行可以对应于基因和列的样品。


参数:cpus
the number of cpus used for correlaiton calcluation. snowfall package in R needed to be installed in advance.  
数量的cpu的用于correlaiton calcluation的。在R中的降雪包需要被预先安装在。


参数:cormethod
a character string that specifies a correlation method to be used for correlation calculation.  
一个字符的字符串,它指定用于相关计算的相关方法。


参数:distancemethod
a character string specifying the distance method to be used. Currently, three distance methods are available, include: "Raw" (1-cor)", "Abs" (1-|cor|), and "Sqr" (1-|cor|^2).  
指定的距离的方法,可以使用一个字符串。目前,有三种不同的距离的方法,包括:“原始”(1-COR)“,”ABS“(1  -  | COR |),”SQR“(1  - 肺心病| ^ 2)。


参数:clustermethod
the distance measure to be used. This must be one of "complete", "average", "median", "centroid", "mcquitty", "single", or "ward".  
要使用的距离测量。这必须是一个“完成”,“平均”,“中位数”,“质心”,“观测组”,“单”,或“病房”。


参数:rowhcdata
the object of class hc generated from gcc.hclust for rows in x.  
HC类的对象产生的gcc.hclust在x行。


参数:colhcdata
the object of class hc generated from gcc.hclust for columns in x.  
gcc.hclust列在x的对象类HC产生的。


参数:keynote
a character string indicating the lable of color key.  
一个字符串,表示拉布勒颜色键。


参数:symm
logical indicating if x should be treated as a symmetrical matrix.  
逻辑指示如果x应被处理为一个对称的矩阵。


参数:scale
a character string specifying if the data values would be centered and scaled by rows or by columns, or none.  
一个字符串指定的中心和缩放的数据值是否会按行或列,或根本没有。


参数:na.rm
logical indicating whether the Nas should be eliminated.  
逻辑指示是否NAS应该被淘汰。


参数:revC
logical indicating if the column order should be reversed for plotting.  
逻辑表示如果列的顺序应该颠倒的图。


参数:add.expr
expression that will be evaluated after the call to image.  
表达式,该表达式将被评估后调用图像。


参数:breaks
(optional)Either a integer number specifying the break points to be used, or a numeric vector indicating the splitting points for binning x into colors.   
(可选),无论是整数,指定破发点,或分割点颜色分级x转换成一个数字矢量。


参数:symbreaks
Boolean indicating whether breaks should be made symmetric about 0. This option works if the quanbreaks is FALSE.  
布尔值,指示是否中断,应对称约0。此选项的作用,如果quanbreaks是FALSE。


参数:colrange
colors used for the image. It could be a function(i.e., heat.colors) or a vector of colors with at leat two elements (e.g., c("green", "black", "red")).   
所使用的颜色的图像。这可能是一个功能(即,heat.colors)或矢量的颜色,在真皮休闲包两个元素(例如,c(“绿色”,“黑”,“红”))。


参数:tissuecol
colors for tissues. tissuecol could be a function(i.e., heat.colors) or a vector of colors for different tissues.  
组织的颜色。 tissuecol可以是函数(即,heat.colors)或在不同组织中的颜色的矢量。


参数:colsep
(optional) vectors of integers indicating which columns should be seperated from the preceding columans by a narrow space of color sepcor.  
(可选)向量整数,表示应分开从前columans的一个狭窄的的颜色sepcor空间的哪些列。


参数:rowsep
(optional) vectors of integers indicating which rows should be seperated from the preceding rows by a narrow space of color sepcor.  
(可选)向量的整数,表示行应分开前行一个狭窄的的颜色sepcor空间的。


参数:sepcolor
(optional) color used to seperate rows or columns.  
(可选)使用单独的行或列的颜色。


参数:sepwidth
(optional) A numeric vector containing two elements giving the width (colsep) or height (rowsep) for the seperation of columns or rows.  
(可选)数字向量,包含两个元素,给人的的宽度(colsep)或的高度(rowsep)行或列的分离。


参数:trace
character string indicating a solid "trace" lined should be drawn across "rows", or "column", or "both" or "none".  
字符串,表示一个坚实的“跟踪”内衬应该画在“行”或“列”,或“都”或“无”。


参数:tracecol
color for trace  
颜色跟踪


参数:hline
vector of values whithin cells where horizontal lines should be drawn with line col.  
矢量线COL应制定与水平线的的值whithin单元。


参数:vline
vector of values whithin cells where vertical lines should be drawn with line col.  
向量垂直线应该画线COL的的值whithin单元。


参数:linecol
color for hline and vline.  
的颜色HLINE和VLine。


参数:margins
a numeric vector containing 2 elements specifying the margins for column and row names, respectively. See (par(mar=*)).  
一个数值向量,分别包含2个元素指定列名和列名的利润率。 (每股(月= *))。


参数:main
main title. defaults to none.  
主标题。默认为none。


参数:xlab
x-axis label. defaults to none.  
X轴标签。默认为none。


参数:ylab
y-axis label. defaults to none.  
y轴的标签。默认为none。


参数:lmat
position matrix for visual layout.   
位置矩阵的可视化布局。


参数:lhei
column height for visual layout.  
柱高度可视化的布局。


参数:lwid
column width for visual layout. For instance, lwid = c(0.5, 0.05, 0.01, 0.5, 0.01, 0.05, 0.5)  
列宽的可视化布局。比如,lwid = C(0.5,0.05,0.01,0.5,0.01,0.05,0.5)


参数:...
additonal arguments passed on to image.  
产生额外的参数传递给图像。


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

A list with the following components:
以下组件列表:


参数:retval
a list with components of "rowInd" (row index of heat map from x), "colInd" (column index of heat map from x), "call" (the match call), "carpet" (reordered and scaled 'x' values used generate the main 'carpet'), "rowDendrogram" (row dendrogram), "colDendrogram" (column dendrogram), "breaks" (break points for binning x), "col" (colors used), and "colorTable" (a data frame providing the lower and upper bound and color for each bin).
“ROWIND”(热图从x行索引),的“colInd”(列索引的热图,从X),“呼”的比赛(调用)的组成部分,“地毯式”(重新排序和一个列表,规模x值产生的主要“地毯”),“rowDendrogram”(行聚类分析),的“colDendrogram”(列树状图),“打破”(打破点分级x),“中国网络”(颜色使用的话),和“colorTable”(一个数据框提供的下限和上限和颜色的各bin)。


参数:hcr
the values returned from gcc.hclust function for clustering individuals (e.g., genes) in row direction
行方向为聚类个人(例如,基因)的返回值gcc.hclust功能


参数:hcc
the values returned from gcc.hclust function for clustering individuals (e.g., genes) in column direction
gcc.hclust函数的返回值,聚类个人(例如,基因)在列方向


(作者)----------Author(s)----------



Chuang Ma, Xiangfeng Wang




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

gcc.dist, cor.matrix, gcc.hclust, gcc.tsheatmap.
gcc.dist,cor.matrix,gcc.hclust,gcc.tsheatmap。


实例----------Examples----------



## Not run: [#不运行:]
   data(rsgcc)
         
   #get expression matrix of tissue-specific genes, here we obtained 2279 ts-genes[组织特异性基因表达矩阵,在这里,我们获得了2279 TS基因]
   x <- getsgene(rnaseq)$tsgene

   #heat map of tissue-specific genes[组织特异性基因的热图]
   thm <- gcc.tsheatmap(x[1:100,], cpus = 1, cormethod = "GCC",
                    distancemethod = "Raw", clustermethod = "complete")

## End(Not run)[#(不执行)]

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


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

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|生物统计家园 网站价格

GMT+8, 2024-11-27 12:44 , Processed in 0.026006 second(s), 16 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表