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

loveR

writeEstProfile(mBPCR)
writeEstProfile()所属R语言包：mBPCR

                                        Write the estimated profile of copy number data
                                         写拷贝数数据估计的个人资料

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

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

Function to write nicely the results of the copy number profile estimation. The function either writes the tables directly on a tab delimited file or returns the corresponding tables.
函数写很好的拷贝数剖面估计结果。函数直接写入制表符分隔的文件中的表或返回相应的表。


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



  writeEstProfile(path='', sampleName='', snpName, chr, position, logratio,
                  chrToBeWritten, estPC, estBoundaries=NULL, postProbT=NULL,
                  regrCurve=NULL, regr=NULL)



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

参数：path
path of the folder where the user wants to write the results of the estimation (it must end with '\' in windows, or '//' in linux). If path='', they will be written in the working directory. If path=NULL, the tables will not be written on a file, but only returned by the function.
用户要编写的估计结果的文件夹路径（它必须结束\窗口/ /在Linux）。如果path=''，他们将写在工作目录。如果path=NULL，该表将不会在文件上写的，但只能由该函数返回。


参数：sampleName
name of the sample. If the name of the sample if provided, it is used to named the files.
样品的名称。如果样品的名称，如果提供，它是用来命名的文件。


参数：snpName
array containing the name of each probe
每个探测器的名称的数组，其中包含


参数：chr
array containing the name of the chromosome to which each probe belongs. The possible values of the elements of chr are: the integers from 1 to 22, 'X' and 'Y'.
数组，其中包含每个探针属于染色体的名称。可能的chr元素值是：从1到22的整数，“X”和“Y”。


参数：position
array containing the physical position of each probe
数组，其中包含每个探针的物理位置


参数：logratio
array containing the log2ratio of the raw copy number data
数组，其中包含的原始拷贝数数据log2ratio


参数：chrToBeWritten
array containing the name of the estimated chromosomes, of which the user wants to write the results. The possible values of the chromosomes are: the integers from 1 to 22, 'X' and 'Y'.
数组，包含估计染色体的名称，用户要写入的结果。染色体可能的值是：从1到22的整数，“X”和“Y”。


参数：estPC
array containing the estimated copy number profile as a piecewise constant function
数组，包含作为一个分段常数函数估计拷贝数配置文件


参数：estBoundaries
list containing the vectors of the estimated breakpoints, for each of the chromosomes mentioned in chrToBeWritten. If estBoundaries=NULL, then this information is not written.
列表包含估计断点的向量，为每个在chrToBeWritten提到的染色体。如果estBoundaries=NULL，那么这个信息不写。


参数：postProbT
list containing the vectors of the posterior probabilities to be a breakpoint of the estimated breakpoints, for each of the chromosomes mentioned in chrToBeWritten. If postProbT=NULL,  then this information is not written in the file containing the estimated breakpoints.
列表中包含的后验概率的向量，是的每个chrToBeWritten提到的染色体断点，估计断点。如果postProbT=NULL，然后这些信息不包含估计断点的文件书面。


参数：regrCurve
array containing the estimated regression curve. If regrCurve=NULL, then the file containing this information is not written.
数组，包含估计回归曲线。如果regrCurve=NULL，则包含此信息的文件，不写。


参数：regr
choice of the computation of the regression curve. If regr=NULL, then the regression curve was not computed (then the file containing this information is not written), if regr="BRC" the Bayesian Regression Curve with K_2 was computed (BRC with K_2),  if regr="BRCAk" the Bayesian Regression Curve Averaging over k was computed (BRCAk).
计算回归曲线的选择。如果regr=NULL，然后回归曲线没有计算（包含此信息的文件不写入），如果regr="BRC"以K_2贝叶斯回归曲线计算（商业登记证与是<X >）如果K_2贝叶斯回归曲线，平均在K计算机（BRCAk）的。


Details

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

The function writes or returns at maximum three tables:
该函数写入或返回最大的三个表：

-one containing the estimated profile with mBPCR (the columns are: 'SNPname', 'chromosome', 'position', 'rawLog2ratio', 'mBPCRestimate')
一个包含估计与mBPCR的个人资料（列有：“SNPname”，“染色体”，“位置”，“rawLog2ratio，mBPCRestimate）

-one containing a summary about the estimated profile with mBPCR  (the columns are: 'SNPname(start)', 'SNPname(end)', 'chromosome', 'position(start)', 'position(end)', 'nProbes', 'mBPCRestimate' and, eventually, 'breakpointPostProb'). This table is not created if estBoundaries=NULL.
一对一包含估计与mBPCR的个人资料（列有关的总结：“（开始）SNPname，SNPname（完）”，“染色体”，“位置（开始）”，“位置（完），nProbes的，mBPCRestimate“，并最终breakpointPostProb”）。如果estBoundaries=NULL不创建此表。

-one containing the estimated profile with a regression curve (the columns are: 'SNPname', 'chromosome', 'position', 'rawLog2ratio' and the name of the regression curve used). This table is not created if regrCurve=NULL.
一个包含估计回归曲线（栏目有：“SNPname”，“染色体”，“位置”，“rawLog2ratio和使用回归曲线的名称）的文件。如果regrCurve=NULL不创建此表。


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



##import the 10K data of cell line REC[＃导入单元株拍摄10K数据]
data(rec10k)
##estimation of chromosome 5[＃5号染色体的估计]
results <- estProfileWithMBPCR(rec10k$SNPname, rec10k$Chromosome, rec10k$PhysicalPosition, rec10k$log2ratio, chrToBeAnalyzed=5, maxProbeNumber=2000)
##write the estimated profile of chromosome 5 in a file in  the working directory[＃写在工作目录中的文件第5号染色体的估计概况]
writeEstProfile(path='', sampleName='rec10k', rec10k$SNPname, rec10k$Chromosome, rec10k$PhysicalPosition, rec10k$log2ratio, chrToBeWritten=5, results$estPC, results$estBoundaries, results$postProbT)


#### the same result can be obtained in the following way, by using the function computeMBPCR for the estimation[＃＃＃同样的结果可以以下列方式取得，使用估计的功能computeMBPCR]
#[]
##estimation of the global parameters[＃全局参数的估计]
#param &lt;- estGlobParam(rec10k$log2ratio)[参数< -  estGlobParam（rec10k美元log2ratio）]
##estimation of chromosome 5[＃5号染色体的估计]
#results &lt;- computeMBPCR(rec10k$log2ratio[rec10k$Chromosome == 5], nu=param$nu, rhoSquare=param$rhoSquare, sigmaSquare=param$sigmaSquare)[结果< -  computeMBPCR人（rec10k美元log2ratio [rec10k美元染色体== 5]，NU =参数$ NU，rhoSquare =参数$ rhoSquare，sigmaSquare的PARAM美元sigmaSquare）]
##write the estimated profile of chromosome 5 in a file in the working directory[＃写在工作目录中的文件第5号染色体的估计概况]
#estPC &lt;- array(dim=length(rec10k$SNPname))[estPC < - 数组（DIM =的长度（rec10k美元）SNPname）]
#estBoundaries &lt;- list(dim=1)[estBoundaries < - 列表（DIM = 1）]
#postProbT &lt;- list(dim=1)[postProbT < - 列表（DIM = 1）]
#estPC[rec10k$Chromosome == 5] &lt;- results$estPC[estPC [rec10k染色体== 5] < - 结果美元estPC]
#estBoundaries[[1]] &lt;- results$estBoundaries[estBoundaries [1] < - 结果美元estBoundaries]
#postProbT[[1]] &lt;- c(results$postProbT[results$estBoundaries[-results$estK]],1)[postProbT [1] < -  C（结果为postProbT结果estBoundaries [结果$ estK]]，1）]
#writeEstProfile(path='', sampleName='rec10k', rec10k$SNPname, rec10k$Chromosome, rec10k$PhysicalPosition, rec10k$log2ratio, chrToBeWritten=5, estPC, estBoundaries, postProbT)[writeEstProfile（路径=，sampleName =rec10k“，rec10k美元SNPname染色体rec10k美元，PhysicalPosition rec10k美元，rec10k美元log2ratio chrToBeWritten = 5，estPC，estBoundaries，postProbT）]

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


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