R语言 snpStats包 write.plink()函数中文帮助文档(中英文对照)

loveR

write.plink(snpStats)
write.plink()所属R语言包：snpStats

                                         Write files for analysis in the PLINK toolset
                                         写文件进行分析，在砰砰工具集

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

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

Given a SnpMatrix object, together with associated subject and SNP support dataframes, this function writes .bed,  .bim, and .fam files for processing in the PLINK toolset
由于SnpMatrix对象，连同相关的主题和SNP支持dataframes，这个功能写在砰砰工具集处理.bed，.bim，.fam文件


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


write.plink(file.base, snp.major = TRUE, snps,
   subject.data, pedigree, id, father, mother, sex, phenotype,
   snp.data, chromosome, genetic.distance, position, allele.1, allele.2,
   na.code = 0)



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

参数：file.base
A character string giving the base filename. The extensions .bed, .bim, and .fam are appended to this string to give the filenames of the three output files  
一个字符串，提供基本文件名。扩展.bed，.bim，.fam追加到这个字符串给三个输出文件的文件名


参数：snp.major
Logical variable controlling whether the .bed file is in SNP-major or subject-major order   
逻辑变量控制是否.bed文件中主要的SNP或学科主要的顺序是


参数：snps
The SnpMatrix or XSnpMatrix object to be written out  
SnpMatrix或XSnpMatrix对象要写出


参数：subject.data
(Optional) A subject support dataframe. If supplied, the next six arguments (which define the fields of the PLINK .fam file) will be evaluated in this environment, after matching row names with the row names of snps. Otherwise they will be evaluated in the calling environment; they then must be of the right length and in the correct order.  
（可选）受支持dataframe。如果提供，未来6个参数（砰砰.fam文件中定义的字段）将在这样的环境评估后，配合snps行名行名。否则，他们将在调用环境评估，然后，他们必须有正确的长度，并以正确的顺序。


参数：pedigree
A pedigree (family) identifier. Default is the row names of snps.  
一个谱系（家庭）标识符。默认是snps行名称。


参数：id
An identifier of an individual within family. Default is a vector of na.code.  
一个家庭内的个人识别码。默认是na.code的向量。


参数：father
The within-family identifier of the subject's father. Default is a vector of  na.code.  
主体的父亲在家庭中的标识符。默认是na.code的向量。


参数：mother
The within-family identifier of the subject's mother. Default is a vector of  na.code.  
受母亲的家庭内的标识符。默认是na.code的向量。


参数：sex
Sex of the individual. Default is a vector of na.code. This will be coerced to type numeric.  
个人的性别。默认是na.code的向量。这将强制键入numeric。


参数：phenotype
The primary phenotype value. Default is a vector of na.code. This will be coerced to type numeric.  
主要表型值。默认是na.code的向量。这将强制键入numeric。


参数：snp.data
(Optional) A SNP support dataframe. If supplied, the next five arguments (which define the  columns of the PLINK .bim file) will be evaluated in this environment,  after matching row names with the column names of snps. Otherwise they will be evaluated in the calling environment;  they then must be of the right length and in the correct order.   
（可选）的SNP支持dataframe。如果提供，将在未来五年参数（砰砰.bim文件中定义的列）在这样的环境评估后，配合snps列名的行名。否则，他们将在调用环境评估，然后，他们必须有正确的长度，并以正确的顺序。


参数：chromosome
The chromosome on which the SNP is located. This should either be numeric, as specified by SPLINK, or character, with "X", "Y", "XY", and "MT" for the non-numeric values. Default  is a vector of  na.code, or a vector of 23's if snps is a XSnpMatrix.  
位于染色体上的SNP。这应该是数字，指定由SPLINK，或字符"X"，"Y"，"XY"，"MT"非数值。默认是na.code，或如果snps是XSnpMatrix23的矢量矢量。


参数：genetic.distance
The location of the SNP, expressed as a genetic distance. Default is a vector of  na.code. This will be coerced to type numeric.  
SNP的位置，表示为遗传距离。默认是na.code的向量。这将强制键入numeric。


参数：position
The physical location of the SNP, expressed in base pairs. Default is a vector of  na.code. This will be coerced to type numeric.  
物理位置的SNP，碱基对。默认是na.code的向量。这将强制键入numeric。


参数：allele.1
A character vector giving the first allele. Default is a vector of "A"s.  
第一等位基因的字符向量。默认是一个"A"的向量。


参数：allele.2
A character vector giving the first allele. Default is a vector of "B"s.  
第一等位基因的字符向量。默认是一个"B"的向量。


参数：na.code
The code to be written for NA in the .fam and .bin output files. It should be numeric (or capable of coercion to numeric).  
NA的.fam和.bin输出文件中的代码被写入。它应该是数字（或强迫数字）。


Details

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

For more details of required codings in .fam and .bim files, see the PLINK documentation.
.fam和.bim文件，看到砰砰文档所需的译码的更多细节。


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

Returns NULL.
返回NULL的。


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


David Clayton <a href="mailto:david.clayton@cimr.cam.ac.uk">david.clayton@cimr.cam.ac.uk</a>



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

http://pngu.mgh.harvard.edu/~purcell/plink/

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

read.plink, SnpMatrix-class, XSnpMatrix-class
read.plink，SnpMatrix-class，XSnpMatrix-class


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


data(testdata)
## the use of as.numeric() below is not necessary since this is done[＃使用as.numeric（），下面是没有必要的，因为这样做]
## automatically. It just illustrates use of expressions for these arguments[＃自动。它只是说明这些参数使用表达式]
## Note that cc and sex are variables within the subject.data frame[＃注意，CC和性别变量内subject.data帧]
## This command writes files test.bed. test.fam and test.bim[＃这个命令写入文件test.bed。 test.fam和test.bim]
write.plink(file.base="test", snps=Autosomes,
    subject.data=subject.data, phenotype = as.numeric(cc), sex=as.numeric(sex),
    snp.major=FALSE)

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


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