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

R语言 siggenes包 link.siggenes()函数中文帮助文档(中英文对照)

[复制链接]
发表于 2012-2-26 14:13:24 | 显示全部楼层 |阅读模式
link.siggenes(siggenes)
link.siggenes()所属R语言包:siggenes

                                        Links for a SAM or an EBAM object
                                         为SAM或EBAM的对象的相关链接

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

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

Generates a html page with links to several public repositories for a list of genes called differentially expressed when using a specific Delta value in a SAM or an EBAM analysis.
生成一个HTML页面链接到几个公共库称为在SAM或EBAM的分析使用特定的Delta值时差异表达的基因列表。


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


  link.siggenes(object, delta, filename, gene.names = NULL, addDataFrame = TRUE,
        entrez = TRUE, refseq = TRUE, symbol = TRUE, omim = FALSE, ug = FALSE,
        fullname = FALSE, which.refseq = "NM", chipname = "", cdfname = NULL,
        refsnp = NULL, max.associated = 2, n.digits = 3, title = NULL,
        bg.col = "white", text.col = "black", link.col = "blue", tableborder = 1,
        new.window = TRUE, load = TRUE)



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

参数:object
a SAM or an EBAM object.
一个SAM或EBAM对象。


参数:delta
a numerical value specifying the Delta value.
指定的Delta值的数值。


参数:filename
character string naming the file in which the output should be stored. Must have the suffix ".html".
字符串命名应存放在输出的文件。必须有后缀“HTML”。


参数:gene.names
a character vector of the same length as object@d (or object@z) containing the names of the genes. Must only be specified if it is not specified in object, i.e. if it has not been specified in sam (or ebam).
object@d(object@z)含有基因的名称相同长度的特征向量。如果不指定必须只指定object,即如果它没有被指定在sam(ebam)。


参数:addDataFrame
logical indicating if gene-specific information on the differentially expressed genes should be added to the output.
逻辑表示如果特定基因的差异表达基因的信息应被添加到输出。


参数:entrez
logical indicating if Entrez links should be added to the output.
Entrez的链接应该被添加到输出逻辑指示。


参数:refseq
logical indicating if RefSeq links should be added to the output.
逻辑指示应被添加到输出的RefSeq链接。


参数:symbol
logical indicating if the gene symbols should be added to the output.
逻辑表明,如果基因符号应该被添加到输出。


参数:omim
logical indicating if OMIM links should be added to the output.
OMIM链接应该被添加到输出逻辑表示。


参数:ug
logical indicating if UniGene links should be added to the output.
逻辑表示如果UniGene的链接应该被添加到输出。


参数:fullname
logical indicating whether the full gene names should be added to the output.
逻辑指示是否应该被添加到输出的完整的基因名称。


参数:which.refseq
character string or vector naming the first two letters of the RefSeq links that should be displayed in the html file.
字符串或向量命名的前两个字母的,应在HTML文件中显示的RefSeq链接。


参数:chipname
character string specifying the chip type used in the analysis. Must be specified as in the meta-data section of Bioconductor (e.g., "hgu133a" for the Affymetrix HG-U133A chip). Needs not to be specified if cdfname is specified. For Affymetrix SNP chips (starting with the 500k array set),  chipname can be specified by the metadata package name, i.e.\ either by "pd.genomewidesnp.5", by "pd.genomewidesnp.6", by "pd.mapping250k.nsp", or by "pd.mapping250k.sty", to add links to the Affymetrix webpage of the SNPs to the html output.
字符串指定在分析中使用的芯片类型。必须指定为Bioconductor元数据部分(例如,"hgu133a"Affymetrix公司的HG-U133A芯片)。需要不被指定,如果cdfname指定。 Affymetrix公司的SNP芯片(500K阵列集开始),chipname可以通过指定的元数据包名称,即\要么"pd.genomewidesnp.5"由"pd.genomewidesnp.6","pd.mapping250k.nsp",或"pd.mapping250k.sty",Affymetrix公司的SNP网页链接添加到HTML输出。


参数:cdfname
character string specifying the cdf name of the used chip. Must exactly follow the nomenclatur of the Affymetrix chips (e.g., "HG-U133A" for the Affymetrix HG-U133A chip). If specified, links to the Affymetrix webpage for the interesting genes will be added to the output. If SNP chips are considered, chipname instead of cdfname must be specified for obtaining these links.
字符串指定所使用的芯片的CDF名称。必须严格遵循的Affymetrix芯片nomenclatur(例如,"HG-U133A"Affymetrix公司的HG-U133A芯片)。如果指定的,有趣的基因的Affymetrix公司的网页链接将被添加到输出。如果被认为是SNP的芯片,chipname而不是cdfname必须获得这些链接指定。


参数:refsnp
either a character vector or a data frame. If the former, refsnp containis the RefSNP IDs of the SNPs used in the SAM/EBAM analysis, where names(refsnp) specifies the names of these SNPs, i.e.\ their probe set IDs. If a data frame, then one column of refsnp must contain the RefSNP IDs of the SNPs, and the name of this column must be RefSNP. The other columns can contain additional annotations such as the chromosome or the physical position of each SNPs. The row names of refsnp must specify the SNPs, i.e.\ must be the probe set IDs of the SNPs. Using buildSNPannotation from the package scrime such a data frame can be generated automatically from the metadata package corresponding to the considered SNP chip.  
无论是字符向量或一个数据框。如果是前者,refsnpcontainis SAM / EBAM分析中使用的SNPs,其中names(refsnp)指定这些SNPs的名称,即\自己的探针集ID RefSNP标识。如果一个数据框,然后一列必须包含refsnp的SNP RefSNP标识,此列的名称必须是RefSNP。其他列可以包含额外的注释,如染色体或每个单核苷酸多态性的物理位置。 \refsnp行名称必须指定的单核苷酸多态性,即必须是探针的SNP集ID。使用buildSNPannotation包scrime这样一个数据框可以自动生成元数据包对应考虑的SNP芯片。


参数:max.associated
integer specifying the maximum number of genes associated with the respective SNP displayed in the html output. If all entries should be shown, set max.associated = 0. This however might result in a very large html output. For details, see  shortenGeneDescription in the package scrime.
整数,指定的HTML输出中显示各自的单核苷酸多态性与相关基因的最大数量。如果所有参赛作品应显示,设置max.associated = 0。然而,这可能会导致一个非常大的HTML输出。有关详细信息,请参阅shortenGeneDescription包scrime的。


参数:n.digits
integer specifying the number of decimal places used in the output.
整数,指定在输出中使用的小数。


参数:title
character string naming the title that should be used in the html page.
字符串命名的,应在HTML页面中使用的标题。


参数:bg.col
specification of the background color of the html page. See ?par for how colors can be specified.
规范的HTML页面的背景颜色。看到?par如何可以指定颜色的。


参数:text.col
specification of the color of the text used in the html page. See ?par for how colors can be specified.
在HTML页面中使用的文本的颜色规范。看到?par如何可以指定颜色的。


参数:link.col
specification of the color of the links used in the html file. See ?par for how colors can be specified.
规范用于在HTML文件中的链接的颜色。看到?par如何可以指定颜色的。


参数:tableborder
integer specifying the thickness of the border of the table.
整数,指定表格边框的厚度。


参数:new.window
logical indicating if the links should be opened in a new window.
逻辑指示应在新窗口中打开链接。


参数:load
logical value indicating whether to attempt to load the required annotation data package if it is not already loaded. For details, see the man page of lookUp in the package annotate.
逻辑值指示是否尝试加载所需的注释数据包,如果它尚未被载入。有关详情,请参阅lookUp包annotate手册页。


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


Holger Schwender, <a href="mailto:holger.schw@gmx.de">holger.schw@gmx.de</a>



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

sam, ebam, link.genes, sam2html, ebam2html
sam,ebam,link.genes,sam2html,ebam2html

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


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

使用道具 举报

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

本版积分规则

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

GMT+8, 2025-1-24 08:42 , Processed in 0.020643 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

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