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

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

[复制链接]
发表于 2012-2-25 21:25:51 | 显示全部楼层 |阅读模式
mendelErr(GWASTools)
mendelErr()所属R语言包:GWASTools

                                        Mendelian Error Checking
                                         孟德尔错误检查

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

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

Mendelian and mtDNA inheritance tests.
孟德尔遗传和线粒体DNA的继承测试。


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


mendelErr(genoData, mendel.list, snp.exclude=NULL,
          error.by.snp=TRUE, error.by.snp.trio=FALSE,
          verbose=TRUE, outfile=NULL)



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

参数:genoData
GenotypeData object, must have scan variable "sex"
GenotypeData对象,必须有扫描变量“性别”


参数:mendel.list
A mendelList object, to specify trios.
一个mendelList对象,指定三重奏。


参数:snp.exclude
An integer vector with snpIDs of SNPs to exclude.  If NULL (default), all SNPs are used.
整数向量与单核苷酸多态性snpIDs排除。如果NULL(默认),用于所有的SNPs。


参数:error.by.snp
Whether or not to output Mendelian errors per SNP. This will only return the total number of trios checked and the total number of errors for each SNP. The default value is TRUE.
是否要输出每单核苷酸多态性孟德尔的错误。这将只返回检查三重奏的总人数和每个SNP的错误总数。默认值是TRUE。


参数:error.by.snp.trio
Whether or not to output Mendelian errors per SNP for each trio. This will return the total number of trios checked and the total number of errors for each SNP as well as indicators of which SNPs have an error for each trio. The default value is FALSE. NOTE:  error.by.snp must be set to TRUE as well in order to use this option. NOTE:  Using this option causes the output to be very large that may be slow to load into R.  
是否要输出每三人每单核苷酸多态性孟德尔错误。这将返回检查三重奏的总人数和每个SNP的错误,以及其中的SNPs为每三人中有一个错误的指标总数。默认值是FALSE。注:error.by.snp必须设置为TRUE以及以使用此选项。注:使用此选项使输出是非常大的可能是缓慢的加载到河


参数:verbose
If TRUE (default), will print status updates while the function runs.
如果TRUE(默认),将打印状态更新,同时运行的功能。


参数:outfile
A character string to append in front of ".RData" for naming the output file.
在前面“。RDATA”命名输出文件追加一个字符串。


Details

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

genoData must contain the scan annotation variable "sex". Chromosome index: 1..22 autosomes, 23 X, 24 XY, 25 Y, 26 mtDNA, 27 missing.
genoData必须包含扫描注释变量“性”。染色体指数:1 .. 22染色体,23 x,24的XY,25Ÿ,26线粒体DNA,27人失踪。

Another file will be saved with the name "outfile.warnings.RData" that contains any warnings generated by the function.
另一个文件将被保存的名称为“outfile.warnings.RData”,它包含的功能产生任何警告。


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

If outfile=NULL (default), mendelErr returns an object of class "mendelClass".  If outfile is specified, no data is returned but mendelErr saves the object to disk as "outfile.RData."
如果outfile=NULL(默认),mendelErr返回一个类“mendelClass”的对象。如果outfile指定,没有数据返回,但mendelErr保存为磁盘的对象“outfile.RData。”

The object contains two data frames: "trios" and "all.trios", and a list: "snp" (if error.by.snp is specified to be TRUE). If there are no duplicate samples in the dataset, "trios" will be the same as "all.trios". Otherwise, "all.trios" contains the results of all combinations of duplicate samples, and "trios" only stores the average values of unique trios. i.e: "trios" averages duplicate samples for each unique subject trio. "trios" and "all.trios" contain the following components:
该对象包含两个数据框:“三重奏”和“all.trios”,和一个列表:“单核苷酸多态性”(如果error.by.snp被指定为TRUE)。如果DataSet中有没有重复的样本,“三重奏”将是“all.trios”相同。否则,“all.trios”包含重复样品的所有组合的结果,和“三重奏”只保存了独特的三重奏的平均值。即:“三重奏”的平均值为每一个独特的主题三人重复样品。 “三重奏”和“all.trios”包含以下组件:


参数:fam.id
Specifying the family ID from the mendel.list object used as input.
指定从家庭作为输入mendel.list对象ID。


参数:child.id
Specifying the offspring ID from the mendel.list object used as input.
指定从后代作为输入mendel.list对象ID。


参数:child.scanID
Specifying the offspring scanID from the mendel.list object used as input. (only in "all.trios")
指定后代作为输入mendel.list对象从scanID。 (“all.trios”)


参数:father.scanID
Specifying the father scanID from the mendel.list object used as input. (only in "all.trios")
指定从作为输入mendel.list对象的父亲scanID。 (“all.trios”)


参数:mother.scanID
Specifying the mother scanID from the mendel.list object used as input. (only in "all.trios")
指定从作为输入mendel.list对象的母亲scanID。 (“all.trios”)


参数:Men.err.cnt
The number of SNPs with Mendelian errors in this trio.
单核苷酸多态性与孟德尔在这三人的错误。


参数:Men.cnt
The total number of SNPs checked for Mendelian errors in this trio. It excludes those cases where the SNP is missing in the offspring and those cases where it is missing in both parents. Hence, Mendelian error rate = Men.err.cnt / Men.cnt.
在这三人的孟德尔错误检查总数的SNPs。它排除了这些情况下,SNP是失踪的后代,这些情况是父母双方失踪。因此,孟德尔的错误率=Men.err.cnt/Men.cnt。


参数:mtDNA.err
The number of SNPs with mtDNA inheritance errors in this trio.
这三人中的线粒体DNA的继承错误的SNPs。


参数:mtDNA.cnt
The total number of SNPs checked for mtDNA inheritance errors in this trio. It excludes those cases where the SNP is missing in the offspring and in the mother. Hence, mtDNA error rate = mtDNA.err / mtDNA.cnt .
这三人中的线粒体DNA的继承错误检查总数的SNPs。它排除了这些情况的SNP的后代,并在母亲失踪。因此,线粒体DNA的错误率=mtDNA.err/mtDNA.cnt。


参数:chr1, ..., chr25
The number of Mendelian errors in each chromosome for this trio.
这三人在每个染色体的孟德尔错误。

"snp" is a list that contains the following components:       
“单核苷酸多态性”是一个列表,包含以下组件:


参数:check.cnt
A vector of integers, indicating the number of trios valid for checking on each SNP.
一个整数向量,表示有效的检查每个SNP的三重奏。


参数:error.cnt
A vector of integers, indicating the number of trios with errors on each SNP.
一个整数向量,表示每个SNP的错误数的三重奏。


参数:familyid.childid
A vector of indicators (0/1) for whether or not any of the duplicate trios for the unique trio, "familyid.childid", have a Mendelian error on each SNP. (Only if error.by.snp.trio is specified to be TRUE).
不论任何重复的独特的三重奏三重奏“familyid.childid”指标(0/1)的一个向量,对每个SNP的孟德尔错误。 (只有error.by.snp.trio被指定为TRUE)。

Warnings:
警告:

If outfile is not NULL, another file will be saved with the name "outfile.warnings.RData" that contains any warnings generated by the function.
如果outfile是不是NULL,另一个文件将被保存的名称为“outfile.warnings.RData”,它包含的功能产生任何警告。


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


Xiuwen Zheng, Matt Conomos



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

mendelList
mendelList


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


library(GWASdata)
data(affy_scan_annot)

# generate trio list[生成三人名单]
men.list <- with(affy_scan_annot, mendelList(family, subjectID, father, mother, sex, scanID))

# create genoData object[创建genoData对象]
ncfile <- system.file("extdata", "affy_geno.nc", package="GWASdata")
nc <- NcdfGenotypeReader(ncfile)
scanAnnot <- ScanAnnotationDataFrame(affy_scan_annot)
genoData <- GenotypeData(nc, scanAnnot=scanAnnot)

# Run![快跑!]
outfile <- tempfile()
mendelErr(genoData, men.list, error.by.snp.trio = TRUE, outfile =
outfile)

# Load the output[负载输出]
R <- getobj(paste(outfile, "RData", sep="."))
names(R)
# [1] "trios"     "all.trios" "snp"[1]“三重奏”all.trios“SNP”]

names(R$trios)
#  [1] "fam.id"      "child.id"    "Men.err.cnt" "Men.cnt"     "mtDNA.err"  [1]“fam.id”的“child.id”的“Men.err.cnt”,“Men.cnt”mtDNA.err“]
#  [6] "mtDNA.cnt"   "chr1"        "chr2"        "chr3"        "chr4"       [6]“mtDNA.cnt”的“chr1”的“chr2”,“chr3”chr4“]
# [11] "chr5"        "chr6"        "chr7"        "chr8"        "chr9"       [11]“chr5”的“chr6”的“chr7”,“chr8”chr9“]
# [16] "chr10"       "chr11"       "chr12"       "chr13"       "chr14"      [16]“chr10”chr11“”chr12“chr13”chr14“]
# [21] "chr15"       "chr16"       "chr17"       "chr18"       "chr19"      [21]“chr15”chr16“”chr17“chr18”chr19“]
# [26] "chr20"       "chr21"       "chr22"       "chr23"       "chr24"      [[26]“chr20”“chr21”chr22“chr23”chr24“]
# [31] "chr25"[[31]“chr25”]

# Mendelian error rate = Men.err.cnt / Men.cnt[孟德尔的错误率= Men.err.cnt / Men.cnt]
data.frame(fam.id = R$trios$fam.id, child.id = R$trios$child.id,
           Mendel.err.rate = R$trios$Men.err.cnt / R$trios$Men.cnt)

names(R$snp)
summary(R$snp$check.cnt)

# summary Mendelian error for first family[总结孟德尔第一家庭的错误]
summary(R$snp[[1]])

# check warnings[检查警告]
warnfile <- paste(outfile, "warnings.RData", sep=".")
if (file.exists(warnfile)) warns <- getobj(warnfile)

close(genoData)
unlink(paste(outfile, "*", sep=""))

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


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

使用道具 举报

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

本版积分规则

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

GMT+8, 2025-2-6 10:13 , Processed in 0.023377 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

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