BcfFile(Rsamtools)
BcfFile()所属R语言包：Rsamtools
Manipulate BCF or VCF files.
操作BCF或vcf文件。
译者：生物统计家园网 机器人LoveR
描述----------Description----------
Use BcfFile() to create a reference to a BCF (and optionally its index) or VCF file. The reference remains open across calls to methods, avoiding costly index re-loading.
使用BcfFile()创建一个1的BCF（和可选的指数）或VCF文件。参考仍然在呼吁开放的方法，避免了昂贵的指数重新加载。
BcfFileList() provides a convenient way of managing a list of BcfFile instances.
BcfFileList()BcfFile实例列表管理提供了一个方便的方式。
用法----------Usage----------
## Constructors
BcfFile(file, index = file,
mode=ifelse(grepl("\\.bcf$", file), "rb", "r"))
BcfFileList(...)
## Opening / closing
## S3 method for class 'BcfFile'
open(con, ...)
## S3 method for class 'BcfFile'
close(con, ...)
## accessors; also path(), index()
## S4 method for signature 'BcfFile'
isOpen(con, rw="")
bcfMode(object)
## actions
## S4 method for signature 'BcfFile'
scanBcfHeader(file, ...)
## S4 method for signature 'BcfFile'
scanBcf(file, ..., param=ScanBcfParam())
## S4 method for signature 'BcfFile'
indexBcf(file, ...)
参数----------Arguments----------
参数：con, object
An instance of BcfFile.
BcfFile实例。
参数：file
A character(1) vector of the VCF or BCF file path or, (for indexBcf) an instance of BcfFile point to a BCF file.
字符（1）向量的VCF的BCF文件的路径，或（indexBcf）BcfFile点到的BCF文件的实例。
参数：index
A character(1) vector of the BCF index.
字符（1）向量的BCF指数。
参数：mode
A character(1) vector; mode="rb" indicates a binary (BCF) file, mode="r" a text (VCF) file.
字符（1）向量;mode="rb"表示二进制（BCF）的文件，mode="r"文本（VCF）文件。
参数：param
An optional ScanBcfParam instance to further influence scanning.
一个可选的ScanBcfParam实例来进一步影响扫描。
参数：...
Additional arguments. For BcfFileList, this can either be a single character vector of paths to VCF / BCF files, or several instances of BcfFile objects.
额外的参数。 BcfFileList，这可能是一个VCF的/ BCF文件，或几个实例BcfFile对象的路径的单一特征向量。
参数：rw
Mode of file; ignored.
文件模式;忽略。
类的对象----------Objects from the Class----------
Objects are created by calls of the form BcfFile().
对象的创建形式BcfFile()检测。
领域----------Fields----------
The BcfFile class inherits fields from the RsamtoolsFile class.
BcfFile类继承RsamtoolsFile类的字段。
函数和方法----------Functions and methods----------
BcfFileList inherits methods from RsamtoolsFileList and SimpleList.
BcfFileList继承RsamtoolsFileList和SimpleList的方法。
Opening / closing:
打开/关闭：
open.BcfFile Opens the (local or remote) path and index (if bamIndex is not character(0)),
open.BcfFile打开（本地或远程）path和index（bamIndex不character(0)）
close.BcfFile Closes the BcfFile con; returning (invisibly) the updated BcfFile. The instance may be
close.BcfFile关闭BcfFilecon;返回（不可见）更新BcfFile。实例可能
Accessors:
存取：
path Returns a character(1) vector of the BCF path name.
路径返回，BCF路径名的字符（1）向量。
index Returns a character(1) vector of BCF index name.
指数返回字符的BCF索引名称（1）向量。
bcfMode Returns a character(1) vector BCF mode.
bcfMode返回一个字符（1）向量的BCF模式。
Methods:
方法：
scanBcf Visit the path in path(file), returning the
scanBcf访问在path(file)的路径，返回
show Compactly display the object.
显示紧显示对象。
作者（S）----------Author(s)----------
Martin Morgan
举例----------Examples----------
fl <- system.file("extdata", "ex1.bcf", package="Rsamtools")
bf <- BcfFile(fl) # implicit index[隐式指数]
bf
identical(scanBcf(bf), scanBcf(fl))
rng <- GRanges(c("seq1", "seq2"), IRanges(1, c(1575, 1584)))
param <- ScanBcfParam(which=rng)
bcf <- scanBcf(bf, param=param) ## all ranges[＃所有范围]
## ranges one at a time 'bf'[＃时间“BF”的范围]
open(bf)
sapply(seq_len(length(rng)), function(i, bcfFile, rng) {
param <- ScanBcfParam(which=rng)
bcf <- scanBcf(bcfFile, param=param)[[1]]
## do extensive work with bcf[＃做的大量工作与BCF]
isOpen(bf) ## file remains open[＃文件仍然开放]
}, bf, rng)
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。
|
发表于 2012-2-26 13:28:26
