R语言 trio包 read.pedfile()函数中文帮助文档(中英文对照)

loveR

read.pedfile(trio)
read.pedfile()所属R语言包：trio

                                         Reading a Ped File
                                         读取PED文件

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

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

Reads a ped file into R and creates a data frame in ped format, or transform the ped file into a matrix in genotype format.
到R一个PED文件读，创建一个PED格式的数据框，或PED文件转换成一个矩阵的基因型格式。


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


read.pedfile(file, first.row = NA, coded = NULL, naVal = 0, sep = " ",
   p2g = FALSE, non.rs.IDs = FALSE, cols4ID=FALSE)



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

参数：file
the filename (if necessary with path) of a ped file that should be read into R.  
（如果必要的路径）的PED文件中的文件名应读入R.


参数：first.row
logical indicating whether the first row of file also contains data for a subject. If FALSE, the first row is assumed to contain the SNP names. By default, read.pedfile tries to figure out automatically if the first column contains the SNP names or data for a subject.  
逻辑的第一行指示是否file还包含一个主题的数据。如果FALSE，第一行被假定为包含的SNP名称。默认情况下，read.pedfile试图找出如果第一列中包含的的SNP名称或数据的自动。


参数：coded
a character string stating how the alleles of the SNPs are coded. Possible values are "12", "AB", "1234", "ATCG". For details, see ped2geno. By default, read.pedfile tries to figure out automatically how the alleles are coded.   
说明的SNP位点的等位基因编码的字符串。可能的值是"12"，"AB"，"1234"，"ATCG"。有关详细信息，请参阅ped2geno。默认情况下，read.pedfile自动试图找出如何进行编码的基因。


参数：naVal
value or character string specifying how missing values in the SNP data are coded.  
值或字符的字符串，该字符串指定的SNP数据中的缺失值如何被编码。


参数：sep
character string specifying how the SNP names in the first row of file are separated. Ignored if first.row = TRUE.  
字符串指定如何的SNP名称的第一行中的file分离。如果忽略first.row = TRUE。


参数：p2g
logical indicating whether the ped file should be transformed into a matrix in genotype format. If FALSE, a data frame in ped format is returned. Otherwise, ped2geno is called within read.pedfile to transform the data frame into a matrix in genotype format, and the matrix is returned.  
逻辑指示是否PED认证文件应该被转化成一个矩阵的基因型格式。如果FALSE，在PED格式的数据框返回。否则，ped2geno内read.pedfile改造中的矩阵型格式的数据框，并返回矩阵。


参数：non.rs.IDs
logical indicating whether (some of) the SNP names are specified by other names than rs-IDs.  
逻辑表明是否一些SNP指定名称的RS-ID比其他的名字。


参数：cols4ID
logical indicating whether columns should be added to output matrix containing the family ID and the individual ID. If FALSE, the individual IDs are used as the row names of the output matrix.  
逻辑指示是否应该被添加到输出矩阵包含家庭ID和个别ID列。如果FALSE，个别的ID作为输出矩阵的行的名称。


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

A data frame in ped format (if p2g = FALSE), or a matrix in genotype format (if p2g = TRUE).
PED格式的数据框（如果p2g = FALSE），或矩阵型格式（如果p2g = TRUE）。


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



Holger Schwender, <a href="mailto:holger.schwender@udo.edu">holger.schwender@udo.edu</a>




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

ped2geno
ped2geno

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


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