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

loveR

limma2biomaRt(affycoretools)
limma2biomaRt()所属R语言包：affycoretools

                                         Function to Create HTML Tables from limma Objects using biomaRt
                                         函数创建使用biomaRt limma对象的HTML表格

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

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

This function is designed to take an ExpressionSet and an lmFit, model.matrix, and contrast object from limma and convert into HTML and text tables using biomaRt. The alternate function limma2biomaRt.na is designed to be run without user intervention.
这个功能是设计一个ExpressionSet和lmFit，model.matrix，和对比度从limma的对象，并将其转换成HTML和文字表使用biomaRt的。备用功能limma2biomaRt.na被设计成无需用户干预的情况下运行。


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


limma2biomaRt(eset, fit, design, contrast, species, links = linksBM()[1:3],
otherdata = annBM()[1:3], ann.source = "entrezgene", adjust = "fdr",
number = 30, pfilt = NULL, fldfilt = NULL, tstat = TRUE,
pval = TRUE, FC = TRUE, expression = TRUE, html = TRUE, text = TRUE,
save = FALSE, addname = NULL, interactive = TRUE, affyid = FALSE)



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

参数：eset
An ExpressionSet containing affymetrix expression values.  
ExpressionSet含Affymetrix的表达值。


参数：fit
An lmFit object.  
lmFit对象。


参数：design
A model.matrix object.  
一个model.matrix对象。


参数：contrast
A contrasts matrix from limma.  
一个对比，从limma矩阵。


参数：species
The species name. This must be in a particular format for biomaRt. An example for human is "hsapiens", or for mouse "mmusculus".
物种的名称。这必须是在一个特定的格式为biomaRt。为人类的例子是的“hsapiens”或“鼠标”mmusculus的。


参数：links
A character vector of things to annotate with hyperlinks to online databases. See linksBM for possible values.
一个事物的特征向量与网上数据库的超链接注释。看到linksBM可能的值。


参数：otherdata
A character vector of things to annotate with text only (i.e., no hyperlinks). See annBM for possible values.
的东西，只用文字注释的特征向量（即，没有超链接）。看到annBM可能的值。


参数：ann.source
The annotation source of the IDs that will be used to annotate the genes. The default value is "entrezgene". See details for other possibilities.
的，将被用来注释基因标识标注来源。默认值是“entrezgene”。详情请参阅其他的可能性。


参数：adjust
Multiplicity adjustment. Choices are "fdr","holm","hommel","bonferroni", or "none". Partial matching allowed.  
多重调整。选择是“FDR”，“冬青”，“HOMMEL”，“邦弗朗尼”，或“无”。允许部分匹配。


参数：number
Number of genes to output to table. See details for more information.  
输出表的基因数目。详情请参阅更多信息。


参数：pfilt
A p-value to filter output. See details for more information.  
p值来过滤输出。详情请参阅更多信息。


参数：fldfilt
A fold change to filter output. See details for more information.  
倍数滤波器输出的变化。详情请参阅更多信息。


参数：tstat
Boolean: Output t-statistics in table? Defaults to FALSE.  
布尔：表中的t-统计量的输出？ FALSE默认。


参数：pval
Boolean: Output (adjusted) p-values in table? Defaults to FALSE.  
布尔型：输出（调整）表中的p值吗？ FALSE默认。


参数：FC
Boolean: Output fold changes in table? Defaults to FALSE.  
布尔：表中的输出倍的变化？ FALSE默认。


参数：expression
Boolean: Output expression values in table? Defaults to TRUE.  
布尔：表中的输出表达式的值吗？ TRUE默认。


参数：html
Boolean: Output data in HTML tables? Defaults to TRUE.  
布尔：HTML表格输出数据？ TRUE默认。


参数：text
Boolean: Output data in text tables? Defaults to TRUE
布尔：文字表格输出数据？ TRUE默认


参数：save
Boolean: Save tables as R objects for further processing? Defaults to FALSE.  
布尔：R对象的表作进一步处理？ FALSE默认。


参数：addname
A character vector to add to the end of the automatically generated output file names. Useful for multiple calls to eliminate over-writing of existing HTML or text tables.
字符向量添加到自动生成的输出文件名的末尾。多个检测，以消除现有的HTML或文本表写作有用。


参数：interactive
Boolean: Is this an interactive call, or run as part of a script (e.g., in an Sweave document)? Defaults to TRUE
布尔：这是一个互动的呼叫，或作为脚本的一部分运行（例如，在一个Sweave文件）？ TRUE默认


参数：affyid
Boolean. Are the IDs used to annotate these data Affymetrix IDs?
布尔值。用来注释这些数据Affymetrix公司标识的ID吗？


Details

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

This function is designed to automatically output HTML tables, with filenames taken from the column names of the contrast matrix. The number of genes output can be controlled several different ways. First, if pfilt and fldfilt are both NULL, the top genes will be output based on the number variable. Otherwise, the genes are filtered based on p-value, fold change, or both. If the genes are filtered this way, the number of genes to be output will be listed and the filter(s) can then be adjusted if necessary.
此功能设计的自动输出HTML表格的对比矩阵的列名的文件名。几种不同的方式，可以控制输出的基因数目。首先，，如果pfilt和fldfilt都NULL，顶部的基因将是基于number变量输出。否则，基因筛选的基础上p值，倍数变化，或两者兼而有之。如果这样的基因筛选，基因的数量输出将列出并过滤器（S）然后如果有必要进行调整。

This function currently only supports Affymetrix data. It is designed for Affymetrix chips that don't have an annotation package, which includes data that have been analyzed using the 're-mapped' CDFs supplied to BioC by MBNI at University of Michigan.
此功能目前仅支持Affymetrix数据。它是专为Affymetrix公司的芯片，没有一个注解包，其中包括已使用提供，由MBNI到BioC在密歇根大学的“重映射”CDFS分析数据。

The IDs that will be used to annotate the genes depend on the source of the data. If, for example, one is using an Affymetrix chip that doesn't have a BioC annotation package, then the IDs will be Affymetrix IDs. To find out the correct name to use for the ann.source argument, one can create a connection to a Biomart database using useMart and then get a list of available Affy arrays using listFilters.
将用来注释基因的ID取决于数据源。例如，如果使用Affymetrix公司的芯片，没有BioC的注解包，然后ID将是Affymetrix公司的ID。找出正确的名称，使用为ann.source参数，可以创建一个连接到Biomart数据库使用useMart，然后得到一个可用Affy阵列列表，使用listFilters。

If one is using one of the re-mapped CDFs from MBNI at University of Michigan, then the IDs to use depend on the mapping used to create the CDF. At this time, only three types of CDFs can be used; EntrezGene, UniGene, and RefSeq. One can determine the correct ann.source argument by creating a connection to a Biomart database, and then calling linksBM(mart, linksBM())[[3]].
如果一个人在密歇根大学从MBNI使用重新映射CDFS之一，然后标识使用取决于用于创建的CDF映射。在这个时候，只有三个类型CDFS可以使用; EntrezGene，UniGene的，和的RefSeq。一个由创建一个到Biomart数据库的连接，可以判断正确ann.source参数，然后调用linksBM(mart, linksBM())[[3]]。


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

If save is TRUE, a list of tables from topTable will be output.
save如果是TRUE从表列表topTable将输出。


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


James W. MacDonald <jmacdon@med.umich.edu>



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

topTable,
topTable

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


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