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

loveR

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

                                         Output Fold Change Data using biomaRt
                                         输出倍数据使用biomaRt

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

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

This function is designed to take an ExpressionSet and some comparisons and output HTML tables. It is very similar to foldFilt except it uses the biomaRt package to annotate genes and the annotate package to create the HTML table(s).
此功能设计的采取ExpressionSet和一些比较和输出HTML表格。这是非常相似foldFilt除非它使用biomaRt包注释基因和注释包创建HTML表（S）。


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


foldFiltBM(object, fold = 1, groups, comps, compnames, species, links =
linksBM()[1:3], otherann = annBM()[1:3], filterfun = NULL, ann.source =
"entrezgene", affyid = FALSE, html = TRUE, text = TRUE, save = FALSE)



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

参数：object
An ExpressionSet object
ExpressionSet对象


参数：fold
The log fold change cutoff to use. Note that this is log base two.
log fold change阈值使用。请注意，这是log base two。


参数：groups
A vector of group identifiers. Probably easiest to use a numeric vector
组标识符的向量。可能最容易使用的数字向量


参数：comps
A list containing all the comparisons to be made. Each list item should be a vector of length two. See details for more information.
一个列表，其中包含所有将要作出的比较。每个列表项应该是一个长度为2的向量。详情请参阅更多信息。


参数：compnames
A character vector of the names for each of the comparisons to be made. This will be the name of the resulting HTML or text file.
特征向量的名称为每个将要作出的比较。这将产生的HTML或文本文件的名称。


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


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


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


参数：filterfun
A filtering function created by genefilter to filter the data using additional criteria. See details for more information
genefilter使用附加条件来筛选数据创建一个过滤功能。详情请参阅有关详细信息，


参数：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”。详情请参阅其他的可能性。


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


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


参数：text
Boolean. Output text tables? Defaults to TRUE
布尔值。输出的文字表？ TRUE默认


参数：save
Boolean. If TRUE, a list will be returned. The first item in the list will be a vector showing the number of 'significant' genes for each comparison. The second item will be a matrix of -1's, 0's and 1's indicating a significant difference, and the direction of the difference. The first item is useful for creating Sweave - based reports and the second is useful for making Vennn diagrams using vennDiagram from the limma package.
布尔值。如果TRUE，将返回列表。列表中的第一个项目将是一个向量，“重大”的基因，每个比较。第二项将是一个矩阵，1，0和1的说明一个重要的差异，差异的方向。第一项是创建Sweave有用 - 基于报告，二是有助于使Vennn图使用vennDiagram从limma包。


Details

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

This function is useful for outputting annotated gene lists for multiple fold change comparisons. The genes will be ordered by the absolute fold change.
这个功能是有用的多个fold change比较输出注释的基因列表。该基因将被责令倍的绝对变化。

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 getAffyArrays.
将用来注释基因的ID取决于数据源。例如，如果使用Affymetrix公司的芯片，没有BioC的注解包，然后ID将是Affymetrix公司的ID。找出正确的名称，使用为ann.source参数，可以创建一个连接到Biomart数据库使用useMart，然后得到一个可用Affy阵列列表，使用getAffyArrays。

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]]。

One can also protect against selecting probesets that have very small expression values for all samples (which likely have a large fold change due to noise, rather than signal) by using the filterfun argument. An example would be:
也可以防止选择具有非常小的表达式的值，所有样品（其中可能有一个大的fold change由于噪音，而不是信号）由使用filterfun参数probesets。一个例子是：

f <- kOverA(1, 6)
F < -  kOverA（1，6）

filt <- filterfun(f)
FILT < -  filterfun（F）

Then add filterfun = filt as an argument to the call to foldFilt.
然后添加作为参数调用foldFiltfilterfun = FILT。


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

Returns a list; see above for the elements of the list. This function is mainly called for the side effect of outputting HTML or text files containing annotated 'significant' gene lists.
返回一个列表，见上面列表中的元素。此功能主要是要求输出HTML或文本文件，其中包含注明“重大”的基因列表的副作用。


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


James W. MacDonald &lt;jmacdon@med.umich.edu&gt;

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


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