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

loveR

flowTrans(flowTrans)
flowTrans()所属R语言包：flowTrans

                                         Optimizing transformations for flow cytometry data.
                                         优化流式单元仪数据转换。

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

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

This is the principal function in the package. The function takes data, a transformation function name, dimension names, and optional preselection parameter as input, and runs the maximum likelihood optimization on the data, performs the transformation, and returns the transformed data together with a list of transformation paramters for each dimension. The optimization is set to maximize the likelihood of the parameters given the data, such that the transformed data is normally distributed. An optional parameter n2f=[T,F] allows an automated preselection of an approximately bivariate normal population via the norm2Filter function. The transformation parameters are then optimized for this preselected region, and finally applied globally to the entire range of data. The optional argument parameters.only=[T,F] specifies whether to return the parameters or the transformed data.
这是包中的主要功能。函数将数据转换功能名称，维度名称，以及可选的预选参数作为输入，并运行对数据的最大似然优化，执行转换，转换后的数据返回列表为每个维度的转换参数研究。优化设置，最大限度地提供的数据，这样转换后的数据是正态分布的参数的可能性。可以通过一个可选的参数n2f=[T,F]norm2Filter功能约二元正常人群的自动预选。这预选区域的转换参数，然后优化，并最终在全球范围内适用于整个范围内的数据。可选的参数parameters.only=[T,F]指定是否返回的参数或转换后的数据。


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


flowTrans(dat, fun, dims, n2f,parameters.only)



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

参数：dat
The data to be transformed, should be a flowFrame object.   
将要转换的数据，应该是一个flowFrame对象。


参数：fun
A character string naming the transformation function to be applied. Can be one of: mclMultivBiexp, mclMultivBoxCox,mclMultivArcSinh, and mclMultivLinLog. The Multiv series of functions estimate common transformation parameters for all dimensions.  
一个字符串，命名转换功能应用。可以是：mclMultivBiexp，mclMultivBoxCox，mclMultivArcSinh，mclMultivLinLog。 Multiv等一系列功能，估计各方面的共同转换参数。


参数：dims
A character vector identifying the dimensions to be transformed.      
一个特征向量确定的尺寸进行改造。


参数：n2f
An optional TRUE, FALSE value identifying whether the data should be prefiltered with norm2Filter to select a region of the data for which to optimize the transformation. Default is FALSE.   
可选的TRUE, FALSE值确定数据是否应与norm2Filter预过滤，选择一个区域的数据，以优化改造。默认FALSE。


参数：parameters.only
A logical specifying whether to return only the parameters, and not the transformed data.  mclMultivArcSinh a, b, c; c=0 mclMultivBiexp   a, b, c, d, f, w; f=0 mclMultivBoxCox  theta mclMultivLinLog  theta  
一个逻辑，指定是否返回参数，而不是转换后的数据。 mclMultivArcSinhA，B，C，C = 0mclMultivBiexpA，B，C，D，F，W，F = 0mclMultivBoxCoxTHETAmclMultivLinLogTHETA


Details

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

The transformation functions are multivariate, common parameter transformations. The implementation utilizes a look up table to call optimization routines for the different transformations as well as optional flowCore and flowClust transformation implementations to optimize parameters and transform data from a single interface. Parameters are optimized such that the transformed data is multivariate-normal.
转换功能是多元的，共同的参数转换。实施利用长达查表调用不同的转换优化程序以及可选的flowCore和flowClust改造实现优化参数和转换数据从一个单一的接口。这样转换后的数据是多元的，正常的参数进行了优化。


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

if parameters.only = FALSE then:
如果parameters.only = FALSE然后：


参数：flowTransResult
A flowTransResult object
一个flowTransResult对象

If parameters.only=TRUE the returned value will be a vector of common transformation parameters:  if mclMultivArcSinh is called, the returned vector will contain a, b, and c=0; if mclMultivBiexp   is called, the returned vector will contain a, b, c, d, w;  if mclMultivBoxCox  is called, the returned vector will contain theta; if mclMultivLinLog  is called, the returned vector will contain theta.
如果parameters.only=TRUE返回值将是一个共同的转换参数向量：如果mclMultivArcSinh被称为，返回的向量，将包含A，B，C = 0;如果mclMultivBiexp被称为，返回的向量将包含，B，C，D，W; mclMultivBoxCox如果被称为，将包含返回的矢量THETA，如果mclMultivLinLog被称为，返回的向量将包含THETA。


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



Greg Finak <greg.finak@ircm.qc.ca>, Raphael Gottardo
<raphael.gottardo@ircm.qc.ca>




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

Transformations for Flow Cytometry. (Submitted)

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


data(GvHD)
result <- flowTrans(GvHD[[1]], "mclMultivArcSinh",
          colnames(GvHD[[1]])[1:2], n2f=FALSE, parameters.only=FALSE)
par(mfrow=c(1,2))
contour(GvHD[[1]][,1:2], main="Untransformed FSC vs SSC")
contour(result$result[,1:2], main="Transformed FSC vs SSC")
summary(result)

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


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