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

loveR

snpgdsIBSNum(SNPRelate)
snpgdsIBSNum()所属R语言包：SNPRelate

                                         The numbers of Identity-By-State (IBS) SNPs
                                         的数字身份，由国家（IBS）的单核苷酸多态性

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

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

Calculate the number of SNPs for identity by state for each pair of samples
计算每对样品的SNP位点进行身份状态


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


snpgdsIBSNum(gdsobj, sample.id = NULL, snp.id = NULL, autosome.only = TRUE,
        remove.monosnp = TRUE, maf = NaN, missing.rate = NaN, num.thread = 1, verbose = TRUE)



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

参数：gdsobj
the gdsclass object in the gdsfmt package
gdsclass对象在gdsfmt包


参数：sample.id
a vector of sample id specifying selected samples; if NULL, all samples are used
一个向量的样品ID指定选取的样本，如果为NULL，所有样本都


参数：snp.id
a vector of snp id specifying selected SNPs; if NULL, all SNPs are used
一个向量指定选定的单核苷酸多态性SNP ID，如果为NULL，所有的SNP


参数：autosome.only
if TRUE, use autosomal SNPs only
如果为TRUE，使用常染色体SNP位点


参数：remove.monosnp
if TRUE, remove monomorphic SNPs
如果为TRUE，删除单态的单核苷酸多态性


参数：maf
to use the SNPs with ">= maf" only; if NaN, no MAF threshold
如果为NaN，没有MAF阈值使用的单核苷酸多态性“> = MAF”;


参数：missing.rate
to use the SNPs with "<= missing.rate" only; if NaN, no missing threshold
如果为NaN，无失阈值使用的单核苷酸多态性“<= missing.rate。”而已;


参数：num.thread
the number of CPU cores used
CPU核心的数量


参数：verbose
if TRUE, show information
如果为TRUE，显示信息


Details

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

The minor allele frequency and missing rate for each SNP passed in snp.id are calculated over all the samples in sample.id.
未成年人的等位基因频率和每个SNP位点的丢失率，通过snp.id计算在所有的样品中sample.id。


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

Return a list (n is the number of samples):
返回一个列表（n为样本数）：


参数：sample.id
the sample ids used in the analysis
在分析中使用的样品的id


参数：snp.id
the SNP ids used in the analysis
在分析中使用的SNP ID的


参数：ibs0
a n-by-n matrix, the number of SNPs sharing 0 IBS
一个数的n×n矩阵，单核苷酸多态性分享0 IBS


参数：ibs1
a n-by-n matrix, the number of SNPs sharing 1 IBS
一个数的n×n矩阵，共享1 IBS的单核苷酸多态性


参数：ibs2
a n-by-n matrix, the number of SNPs sharing 2 IBS
一个数的n×n矩阵，共用2 IBS的单核苷酸多态性


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


Xiuwen Zheng <a href="mailto:zhengx@u.washington.edu">zhengx@u.washington.edu</a>



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

snpgdsIBS
snpgdsIBS


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


# open an example dataset (HapMap)[打开示例数据集（人类基因组单体型图）]
genofile <- openfn.gds(snpgdsExampleFileName())

RV <- snpgdsIBSNum(genofile, num.thread=2)
pop <- read.gdsn(index.gdsn(genofile, c("sample.annot", "pop.group")))
L <- order(pop)
image(RV$ibs0[L, L]/length(RV$snp.id))

# close the genotype file[关闭基因型文件]
closefn.gds(genofile)

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


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