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

loveR

calcSpmCollection(KCsmart)
calcSpmCollection()所属R语言包：KCsmart

                                         KCsmart Comparative wrapper
                                         KCsmart比较包装

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

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

Wrapper function that calculates the sample point matrix collection from the aCGH data. The sample point matrix collection is used in the comparative version of KCsmart.
包装函数计算从aCGH数据采样点矩阵集合。用于采样点矩阵集合在比较KCsmart版本。


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


calcSpmCollection(data, mirrorLocs, cl=NULL, data2=NULL, sigma=1000000, sampleDensity=50000, maxmem=1000, verbose=F, doChecks=T, old=F)



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

参数：data
The aCGH data. Can either be in DNAcopy format or as a data.frame described in the details section  
aCGH数据。可以是在细节部分描述了一个，在DNAcopy格式或数据框


参数：mirrorLocs
List containing the chromosome start, centromere and end positions  
列表中包含的染色体开始，着丝粒和结束位置


参数：cl
A class vector indicating which samples belong to which class
说明该样品属于A类矢量哪一类


参数：data2
Instead of a class vector a second data set can be provided which will be combined with the first data set into one sample point matrix collection
一类向量，而不是第二个数据可以提供一套将设置一个采样点矩阵收集到的第一个数据相结合


参数：sigma
The kernel width  
内核的宽度


参数：sampleDensity
The sample point matrix resolution  
采样点矩阵决议


参数：maxmem
This parameter controls memory usage, set to lower value to lower memory consumption  
此参数控制内存的使用，设置为较低的值，以较低的内存消耗


参数：verbose
If set to false, no progress information is displayed  
如果设置为false，没有取得任何进展的信息显示


参数：doChecks
If set to false, the data will not be checked for consistency  
如果设置为false，数据不会被检查一致性


参数：old
If set to true the old implementation of KCsmart will be used to calculate the spm  
如果设置为true老的KCsmart的实施，将被用来计算SPM


Details

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

The input can either consist of a single data set and a class vector or two separate datasets. In the latter case a class vector will be created assigning each data set to its own class. 'data' can be in cghRaw (CGHbase), DNAcopy or in data.frame format. When using the latter, the data.frame must have the following two columns: 'chrom' stating the chromosome the probe is located on, 'maploc' describing the position on the chromosome of the probe. The remainder of the data.frame will be interpreted as sample data points. The row names of that data will be used as probe names (when available). Important note: the data can not contain any missing values. If your data includes missing values you will need to preprocess (for example impute) it using other software solutions.
输入可以由一个单一的数据集和一类向量或两个独立的数据集。在后一种情况下，将创建一类向量分配设置为自己的类的每一个数据。 “数据”可以在cghRaw（CGHbase），DNAcopy或数据框格式。使用后者时，数据框必须有以下两列：“铬”，说明上，“maploc”描述探针染色体上的位置位于染色体的探针。其余的数据框将被解释为样本数据点。该数据行的名称将被用作探针的名称（可用时）。重要说明：数据不能包含任何遗漏值。如果您的数据包括缺失值，您将需要进行预处理（例如归罪于）使用其他软件解决方案。

The mirror locations for Homo Sapiens and Mus Musculus are provided in the package. These can be loaded using data(hsMirrorLocs) and data(mmMirrorLocs)  respectively. The 'mirrorLocs' object is a list with vectors containing the start, centromere (optional) and end of each chromosome as the list elements. Additionally it should  contain an attribute 'chromNames' listing the chromosome names of each respective list element.
智人和小家鼠的镜子位置提供的包中。这些都可以使用数据（hsMirrorLocs）和数据（mmMirrorLocs）分别装入。 mirrorLocs“对象是一个包含列表元素的开始，每个染色体着丝粒（可选）和年底的向量。此外，它应该包含属性“chromNames”上市各自的列表元素的染色体名。

'sigma' defines the kernel width of the kernel used to convolute the data.
“西格玛”定义内核的内核用于回旋的数据宽度。

'sampleDensity' defines the resolution of the sample point matrix to be calculated. A sampleDensity of 50000 would correspond to a sample point every 50k base pairs.
“sampleDensity”定义的采样点矩阵计算的决议。一个50000 sampleDensity，将对应的样本点每50000个碱基对。

'old' can be used if you want to reproduce data that was generated with old (pre 2.9.0) versions of KCsmart, for any new analyses we recommend this flag to be set to false
可以用老如果你想复制数据与旧版本（2.9.0预）的KCsmart的产生任何新的分析，我们建议这个标志被设置为false


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

Returns a sample point matrix collection object. The object has several slots of which the 'data' slot contains a matrix with the kernel smoothed estimates of all samples. The sample point matrix collection contains the following additional slots: cl: A class vector indicating which samples belong to which class.  annotation: The annotation (containing the chromosome and position on the chromosome) for the sample points in the 'data' slot
返回一个采样点矩阵集合对象。该对象有几个插槽插槽包含了所有样品的内核平滑估计的矩阵，其中的“数据”。采样点矩阵集合包含以下附加插槽：CL：表明样品属于A类向量类。注释：在“数据”槽采样点的注释（含染色体和染色体上的位置）

The other slots just represent the parameters used to calculate the sample point matrix collection.
其他插槽只是表示用于计算样本点矩阵集合的参数。

Use 'compareSpmCollection' to get a 'compKc' object for which the significant regions can be calculated using 'getSigRegionsCompKC'.
使用“compareSpmCollection”得到一个compKc“的对象，可以计算出使用getSigRegionsCompKC”的重大区域。


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


Jorma de Ronde



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

compareSpmCollection,  getSigRegionsCompKC
compareSpmCollection，getSigRegionsCompKC


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


data(hsSampleData)
data(hsMirrorLocs)

spmc1mb <- calcSpmCollection(hsSampleData, hsMirrorLocs, cl=c(rep(0,10),rep(1,10)))
spmcc1mb <- compareSpmCollection(spmc1mb, nperms=3)
spmcc1mbSigRegions <- getSigRegionsCompKC(spmcc1mb)

plot(spmcc1mb, sigRegions=spmcc1mbSigRegions)


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


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