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

loveR

eSetDimName(rqubic)
eSetDimName()所属R语言包：rqubic

                                         Get dimname from an eSet object
                                         从ESET对象dimname

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

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

This function is implemented to automatically validate and choose feature (sample) names from the user input. This function is exported for the purpose of easing other Bioconductor developers performing the similar job, and is not tended to be called by end-user directly.
此功能实现自动验证和选择功能（范例）从用户输入的名称。此功能导出的缓和其他Bioconductor开发商进行类似的工作的目的，不倾向于由最终用户直接调用。


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


eSetDimName(eset, input, type = c("feature", "sample"))



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

参数：eset
An object of eSet class, mostly an ExpressionSet class.
eSet类，大多一个ExpressionSet类的对象。


参数：input
The user input, see details below
用户的输入，详见下文


参数：type
Either "feature" or "sample", indicating which dimension should be determined
无论是“功能”或“样品”，表示应确定哪些维度


Details

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

The input can be one of the following three possibilities:
输入可以是以下三种可能性：

Missing. Depending on the type, the results of calling featureNames (“feature”) or sampleNames (“sample”) on the eset object will be returned.
失踪。根据不同的类型，调用featureNames（“功能”）或sampleNames（“样本”）eset对象将返回的结果。

A character string of length 1. Depending on the type, it is first to be machted to the column names of either fData or pData results of the eset object. If found, the values in that column are returned (coerced to characters if necessary). If not found, the function stops by raising an error.
一个长度为1的字符串。根据不同的类型，这是首先要machted要么fData或pDataeset对象的结果中的列名。如果发现，该列中的值被返回（裹挟如果有必要的字符）。如果没有找到，该函数将停止提高一个错误。

A character vector of the length equal to one of the two dimensions of the eset. In this scenario, the function only validates the equality of the length, coerces the input into characters, and return them.
一个特征向量的长度等于ESET的两个方面之一。在这种情况下，该功能只验证了平等的长度，强制转换成字符的输入，并返回它们。

If none of the scenarios above was met, the function stops by raising an error.
如果上述情况都不满足，函数会引发错误。


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

A vector of characters, the length of which determined by the
一个字符向量，其长度取决于


注意----------Note----------

A special case arises if one of the dimensions of the eset object is 1: In this case, the input value is interpreted as the new name and returned. No column name match will take place in this case.
一个特殊情况时，如果尺寸eset对象是1：在这种情况下，输入值被解释为新的名称，并返回。没有列名的比赛将在这种情况下举行。


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


Jitao David Zhang <jitao_david.zhang@roche.com>



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

sampleNames, featureNames, fData, pData
sampleNames，featureNames，fData，pData

writeQubicInputFile calls the function.
writeQubicInputFile调用该函数。


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


data(sample.ExpressionSet)
sub.eset <- sample.ExpressionSet[1:3, 1:3]

## usage one:[＃用法是：]
eSetDimName(sub.eset, type="feature")
eSetDimName(sub.eset, type="sample")

## usage two[＃使用2]
## "sex" is one column in the pData(sub.eset) [＃“性”是一个在PDATA列（sub.eset）]
eSetDimName(sub.eset, input="sex", type="sample")
## Not run: eSetDimName(sub.eset, input="foo", type="sample")[＃不运行：eSetDimName（sub.eset，输入=“富”，键入“样本”）]

## usage three[＃使用3]
eSetDimName(sub.eset, input=paste("Sample", 1:3), type="sample")
## Not run: eSetDimName(sub.eset, input=paste("Sample", 1:4),[＃运行：eSetDimName（sub.eset，输入=粘贴（“样品”，1:4），]
type="sample")
## End(Not run)[＃结束（不运行）]

## special case: dim equals to one[＃特殊情况：昏暗等于一]
eSetDimName(sub.eset[,1], input="foo", type="sample")

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


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