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

loveR

convertNcdfGds(GWASTools)
convertNcdfGds()所属R语言包：GWASTools

                                        Convert between NetCDF and GDS format
                                         NetCDF的和GDS格式之间转换

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

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

convertNcdfGds converts a genotype NetCDF file to the GDS format used by the R packages gdsfmt and SNPRelate.
convertNcdfGds转换基因型netCDF文件的GDS格式的R包gdsfmt和SNPRelate使用。

convertGdsNcdf converts a GDS file to NetCDF format.
convertGdsNcdfNetCDF的格式转换GDS的文件。

checkNcdfGds checks whether a genotype NetCDF file and a GDS file contain identical data.
checkNcdfGds检查基因型netCDF文件和一个GDS文件是否包含相同的数据。


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


convertNcdfGds(ncdf.filename, gds.filename,
  sample.annot = NULL, snp.annot = NULL, rsID.col = "rsID",
  alleleA.col = "alleleA", alleleB.col = "alleleB",
  zipflag = "zip.max", verbose = TRUE)

convertGdsNcdf(gds.filename, ncdf.filename, verbose = TRUE)

checkNcdfGds(ncdf.filename, gds.filename, verbose = TRUE)



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

参数：ncdf.filename
name of the NetCDF genotype file
NetCDF的基因型文件名称


参数：gds.filename
name of the GDS file
GDS的文件名称


参数：sample.annot
a data.frame with sample annotation
一个样本标注数据框


参数：snp.annot
a data.frame with SNP annotation
一个SNP的注释数据框


参数：rsID.col
the name of the snp.annot column with rs ID
snp.annot与RS的ID列的名称


参数：alleleA.col
the name of the snp.annot column with allele A
等位基因Asnp.annot列名


参数：alleleB.col
the name of the snp.annot column with allele B
snp.annotB等位基因的列的名称


参数：zipflag
the compression format for the GDS file, one of "", "ZIP", "ZIP.fast", "ZIP.default", or "ZIP.max"
为GDS的压缩文件格式，“一”，“邮政编码”，“ZIP.fast”，“ZIP.default”，或“ZIP.max”


参数：verbose
whether to show progress information
是否显示进度信息


Details

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

These functions require that the package gdsfmt be installed.  convertNcdfGds is needed to convert the NetCDF genotype files used in this package to the format required by SNPRelate for Principal Component Analysis, Identity-by-Descent, and Linkage Disequlibrium calculations.
这些功能的要求，包gdsfmt安装。 ，convertNcdfGds需要转换NetCDF的基因型在此包使用到SNPRelate主成分分析，身份的下降，连锁不平衡计算所需的格式的文件。


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

checkNcdfGds returns TRUE if the NetCDF and GDS files contain identical data.  If the files differ, it will print a diagnostic message and return FALSE.
checkNcdfGds回报TRUE如果创建NetCDF和GDS文件包含相同的数据。如果文件不同，它会打印一个诊断消息，并返回FALSE。


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


Xiuwen Zheng



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

gdsfmt, SNPRelate, ncdf, NcdfGenotypeReader,
gdsfmt，SNPRelate，ncdf，NcdfGenotypeReader


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


library(GWASdata)
ncfile <- system.file("extdata", "illumina_geno.nc", package="GWASdata")

data(illumina_snp_annot)
data(illumina_scan_annot)

gdsfile <- tempfile()
convertNcdfGds(ncfile, gdsfile, sample.annot=illumina_scan_annot,
  snp.annot=illumina_snp_annot, rsID.col="rsID",
  alleleA.col="allele.A", alleleB.col="allele.B")

checkNcdfGds(ncfile, gdsfile)

ncfile2 <- tempfile()
convertGdsNcdf(gdsfile, ncfile2)

file.remove(gdsfile, ncfile2)

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


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