找回密码
 注册
查看: 413|回复: 0

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

[复制链接]
发表于 2012-10-1 12:07:14 | 显示全部楼层 |阅读模式
trio.check(trio)
trio.check()所属R语言包:trio

                                        Check Case-Parent Trio Data for Mendelian Errors
                                         检查案例父孟德尔遗传错误的的三重奏数据为

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

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

This function checks case-parent trio data in linkage or genotype format for Mendelian errors. If no errors are found, the function returns an object suitable for input to the trio.prepare function. Otherwise, an object identifying the Mendelian errors is
此功能检查的情况下,父母三人的数据链接或基因型格式为孟德尔错误。如果没有发现错误,该函数返回输入trio.prepare功能的合适对象。否则,一个对象确定孟德尔错误的


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


trio.check(dat, is.linkage=TRUE, replace=FALSE)



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

参数:dat
A matrix or data frame of pedigree data in linkage format, or in genotype format.  If the data are in <STRONG>linkage format</STRONG>, the file has to have the standard linkage/pedigree format. Each row describes an individual, and the columns are <famid> <pid> <fatid> <motid> <sex> <affected> <genotype:1_1> <genotype:1_2> ... <genotype:n_1> <genotype:n_2>.  Here, <famid> is a unique identifier for each family, <pid> is a unique identifier for an individual within each family, <fatid> and <motid> identify the father and mother of the individual, <sex> denotes the gender, using the convention 1=male, 2=female, <affected> denotes the disease status (0=unknown, 1=unaffected, 2=affected). Only one phenotype column is allowed. Each genotype is encoded using two columns (<genotype:k_1> and <genotype:k_2>), identifying the alleles (1 for the major allele, 2 for the minor allele, 0 if missing).  Other values for the alleles will result in an error. Please see the data frames trio.ped1 and trio.ped2 contained in this package as examples for trio data in linkage file format (complete and with missing records, respectively).  If the data are in <STRONG>genotype format</STRONG>, each row in the object describes an individual, and each block of three consecutive rows describes the two parents and the affected child in a trio. The columns in the object are <famid> <pid> <genotype_1> ... <genotype_n>.  Here, <famid> is a unique identifier for each family, <pid> is a unique identifier for an individual within each family (with each block of three consecutive rows describing the two parents and the affected child in a trio).  Each <genotype> is encoded as an integer indicating the number of variant alleles (e.g. 0=common homozygote, 1=heterozygote, and 2=rare homozygote, and NA=missing genotype).  Please see the data frames trio.gen1 and trio.gen2 contained in this package as examples for trio data in linkage file format (complete and with missing records, respectively).  
矩阵或数据框中的数据的联动格式,或基因型格式的血统。如果数据是在<STRONG>联动格式</ STRONG>,该文件必须有联动/家系的标准格式。每一行描述一个单独的,和列<famid> <PID>的<fatid> <motid> <sex> <affected> <genotype:1_1> <genotype:1_2> <genotype:n_1> <genotype:n_2>。在这里,<famid>是每个家庭的唯一标识符,<pid>是唯一的标识符为每个家庭<fatid>内的个人和<motid>识别的父亲和母亲的个体,<sex>表示性别,使用约定1 =男,2女,<affected>表示的疾病状态(0 =未知,1 =未受影响,2 =影响)。允许只有一个表型柱。每个基因编码使用两列(<genotype:k_1> <genotype:k_2>)的,确定等位基因(1次要等位基因的主要等位基因,2,0,如果缺少)。的等位基因的其他值,将导致一个错误。请参阅数据框trio.ped1和trio.ped2包含在此包中的例子三人中的数据联动的文件格式(完整的和丢失的记录,分别)。如果数据是在<STRONG>的基因型格式</ STRONG>,对象中的每一行描述了一个个人,每块三个连续行描述了两个父母和受影响的孩子在一个三重奏。对象中的列<famid> <PID> <genotype_1> ... <genotype_n>。在这里,<famid>是一个唯一的标识符为每一个家庭,每一个家庭内的个人(三个连续行描述两个在三人的父母和受影响的儿童每块)<pid>是一个唯一的标识符。每个<genotype>被编码为一个整数,指示变异等位基因的数量(例如,0 =普通纯合子,杂合子,1 = 2 =罕见的纯合子,和NA=缺少基因型)。请参阅数据框trio.gen1和trio.gen2包含在此包中的例子三人中的数据联动的文件格式(完整的和丢失的记录,分别)。


参数:is.linkage
A logical value indicating if the case parent data are in linkage file format (TRUE) or in genotype format (FALSE).
一个逻辑值,表示如果的情况下的父数据是在联动文件格式(TRUE)或在基因型格式(FALSE)。


参数:replace
A logical value indicating whether existing Mendelian errors should be replaced by missing values. For each Mendelian error found (for a particular trio at a particular locus), all three genotypes are replaced by NA, and an object suitable for input to the trio.prepare function is returned.
一个逻辑值,该值指示是否应更换现有的孟德尔遗传错误的遗漏值的。对于每个孟德尔发现的错误(在一个特定的位点特定的三人),所有三个基因型NA,并适用于输入到trio.prepare函数返回的一个目的所取代。


Details

详细信息----------Details----------

The first function used from this package should always be trio.check.  Unless otherwise specified, this function assumes that the data are in linkage format, however, genotype data can also be accommodated.  If no Mendelian inconsistencies in the data provided are identified, trio.check creates an object that can be processed in the subsequent analysis with the trio.prepare function. If the data were in linkage format, the genotype information for each SNP will be converted into a single variable, denoting the number of variant alleles.
第一个函数用于从这个包应该永远是trio.check。除非另有说明,此函数假定该数据是联动的格式,但是,基因型数据也可以被容纳。如果被识别,所提供的数据没有孟德尔不一致trio.check创建一个对象,该对象可以与trio.prepare在后续的分析功能处理。如果数据是在联动格式,每个SNP的基因型信息将被转换成一个单一的变量,表示变异等位基因的数目。

To delineate the genotype information for the pseudo-controls in the subsequent analysis, the trio data must not contain any Mendelian errors. The function trio.check returns a warning, and an R object with relevant information when Mendelian errors are encountered in the supplied trio data.  It is the users responsibility to find the cause for the Mendelian errors and correct those, if possible. However, Mendelian inconsistencies are often due to genotyping errors and thus, it might not be possible to correct those in a very straightforward manner. In this instance, the user might want to encode the genotypes that cause theses Mendelian errors in some of the trios as missing data.  The function trio.check
要划定的基因型信息的伪控制在随后的分析中,他们三人的数据必须不包含任何孟德尔的错误。函数trio.check返回一个警告,并R对象的相关信息时,提供的三人数据孟德尔中遇到的错误。自己身上找原因为孟德尔的错误,并纠正这些问题,如果可能的话,这是用户的责任。在但是,孟德尔不一致往往是由于基因分型错误,因此,它可能不会纠正这些在一个非常简单的方式。在此实例中,用户可能希望编码导致这些孟德尔错误在一些为缺失数据的三重奏的基因型。该功能trio.check


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

The function trio.check returns a list with the following elements:
函数trio.check返回一个列表,包含下列元素:


参数:trio
A data frame with the genotypes of the trios, suitable for input to the function trio.prepare. This element will be NULL if Mendelian errors are detected.
一种数据框与基因型的三重奏,适合于输入到函数trio.prepare。此元素将NULL,如果孟德尔遗传检测到错误。


参数:errors
This element will be NULL if no Mendelian errors are detected. Otherwise, this element will be a data frame with five columns, indicating the Mendelian errors detected in the object dat. The five columns of the data frame refer to the trio  (trio), the family id (famid), the genotype (snp), the row numbers (r), and the column numbers (c).
此元素将NULL,如果没有孟德尔的错误被检测到。否则,该元素将有五列是一个数据框,表明孟德尔检测到的错误的对象dat。五列的数据框参考的三重奏(trio),家庭ID(famid),基因型(snp),行号(r)和列号(c)。


参数:trio.err
This element will be NULL if no Mendelian errors are detected. Otherwise, this element will be a data frame with the trio genotype data. If the input was a linkage file, the data will be converted from alleles to genotypes. If the input was a genotype file, this element will be identical to the input.
此元素将NULL,如果没有孟德尔的错误被检测到。否则,该元素将是一个数据框的三重奏基因型数据。如果输入的是一个联动的文件,将被转换的数据从等位基因以基因型。如果输入的是一个基因型文件,该元素将是相同的输入。


(作者)----------Author(s)----------


Qing Li, mail2qing@yahoo.com



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

and Ruczinski, I. (2010). Detection of SNP-SNP Interactions in Trios of Parents with Schizophrenic Children. Genetic Epidemiology, 34, 396-406.

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

trio.prepare
trio.prepare


实例----------Examples----------


data(trio.data)
trio.tmp = trio.check(dat=trio.ped1)
str(trio.tmp, max=1)
trio.tmp$trio[1:6,]

trio.tmp = trio.check(dat=trio.ped.err)
str(trio.tmp, max=1)
trio.tmp$errors
trio.tmp$trio.err[1:3, c(1,2, 11:12)]
trio.ped.err[1:3,c(1:2, 23:26)]

trio.tmp = trio.check(dat=trio.gen.err, is.linkage=FALSE)
trio.tmp$errors
trio.tmp$trio.err[1:6, c(1,2,7), drop=FALSE]

trio.rep = trio.check(dat=trio.gen.err, is.linkage=FALSE, replace=TRUE)
trio.rep$trio[1:6,c(1,2,7)]


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


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

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|生物统计家园 网站价格

GMT+8, 2024-11-29 18:45 , Processed in 0.033911 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表