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

loveR

TabixFile(Rsamtools)
TabixFile()所属R语言包：Rsamtools

                                        Manipulate tabix indexed tab-delimited files.
                                         操作TABIX索引制表符分隔的文件。

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

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

Use TabixFile() to create a reference to a Tabix file (and its index). Once opened, the reference remains open across calls to methods, avoiding costly index re-loading.
使用TabixFile()创建一个引用到TABIX文件（和它的索引）。一旦打开，基准仍然在呼吁开放的方法，避免了昂贵的指数重新加载。

TabixFileList() provides a convenient way of managing a list of TabixFile instances.
TabixFileList()TabixFile实例列表管理提供了一个方便的方式。


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



## Constructors

TabixFile(file, index = paste(file, "tbi", sep="."), ...)
TabixFileList(...)

## Opening / closing

## S3 method for class 'TabixFile'
open(con, ...)
## S3 method for class 'TabixFile'
close(con, ...)

## accessors; also path(), index()

## S4 method for signature 'TabixFile'
isOpen(con, rw="")

## actions

## S4 method for signature 'TabixFile'
seqnamesTabix(file, ...)
## S4 method for signature 'TabixFile'
headerTabix(file, ...)
## S4 method for signature 'TabixFile,RangesList'
scanTabix(file, ..., param)
## S4 method for signature 'TabixFile,RangedData'
scanTabix(file, ..., param)
## S4 method for signature 'TabixFile,GRanges'
scanTabix(file, ..., param)

## S4 method for signature 'TabixFile'
yieldTabix(file, ..., yieldSize=1000000L)

## S4 method for signature 'TabixFile'
scanVcfHeader(file, ...)
## S4 method for signature 'TabixFile,RangesList'
scanVcf(file, ..., param)
## S4 method for signature 'TabixFile,RangedData'
scanVcf(file, ..., param)
## S4 method for signature 'TabixFile,GRanges'
scanVcf(file, ..., param)
## S4 method for signature 'TabixFile,ScanVcfParam'
scanVcf(file, ..., param)




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

参数：con
An instance of TabixFile.
TabixFile实例。


参数：file
For TabixFile(), A character(1) vector to the tabix file path; can be remote (http://, ftp://). For others, a TabixFile instance.
对于TabixFile（一个字符（1）向量TABIX文件路径）;可以是远程的（http://相似，ftp://）。对于其他人，TabixFile实例。


参数：index
A character(1) vector of the tabix file index.
一个字符（1）向量TABIX文件索引。


参数：param
An instance of GRanges, IRangedData, or RangesList, used to select which records to scan.
一个农庄，IRangedData，或RangesList的，例如用于选择扫描的记录。


参数：yieldSize
integer(1) indicating the maximum number of records to retreieve.
整数（1）显示的最大记录数，以retreieve。


参数：...
Additional arguments. For TabixFileList, this can either be a single character vector of paths to tabix files, or several instances of TabixFile objects.
额外的参数。 TabixFileList，这可以是单个字符向量TABIX文件的路径，或几个实例TabixFile对象。


参数：rw
character() indicating mode of file; not used for TabixFile.
说明文件模式字符（）;不使用TabixFile。


类的对象----------Objects from the Class----------

Objects are created by calls of the form TabixFile().
对象的创建形式TabixFile()检测。


领域----------Fields----------

The TabixFile class inherits fields from the RsamtoolsFile class.
TabixFile类继承RsamtoolsFile类的字段。


函数和方法----------Functions and methods----------

TabixFileList inherits methods from RsamtoolsFileList and SimpleList.
TabixFileList继承RsamtoolsFileList和SimpleList的方法。

Opening / closing:
打开/关闭：




open.TabixFile Opens the (local or remote) path and
open.TabixFile打开（本地或远程）path“




close.TabixFile Closes the TabixFile con; returning (invisibly) the updated TabixFile. The instance may be
close.TabixFile关闭TabixFilecon;返回（不可见）更新TabixFile。实例可能

Accessors:
存取：




path Returns a character(1) vector of the tabix path name.
路径返回字符的TABIX路径名（1）向量。




index Returns a character(1) vector of tabix index name.
索引返回一个字符（1）向量TABIX索引名称。

Methods:
方法：




seqnamesTabix Visit the path in path(file), returning
seqnamesTabix访问在path(file)的路径，返回




headerTabix Visit the path in path(file), returning the sequence names, column indicies used to sort the file, the number of lines skipped while indexing, the comment character used while indexing, and the header (preceeded by comment character, at
headerTabixpath(file)访问路径，返回序列的名称，使用的文件进行排序的列序号为索引时跳过的行数，注释字符时使用索引，头（preceeded注释字符，




scanTabix Visit the path in path(file), returning the
scanTabix访问在path(file)的路径，返回




indexTabix This method operates on file paths, rather than TabixFile objects, to index tab-separated files. See
indexTabix这种方法操作文件路径，而不是比TabixFile对象，指数制表符分隔的文件。见




scanVcfHeader see scanVcfHeader
scanVcfHeader看到scanVcfHeader




scanVcf see scanVcf
scanVcf看到scanVcf




show Compactly display the object.
显示紧显示对象。


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


Martin Morgan



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



fl <- system.file("extdata", "example.gtf.gz", package="Rsamtools")
tbx <- TabixFile(fl)

param <- GRanges(c("chr1", "chr2"), IRanges(c(1, 1), width=100000))
res <- scanTabix(tbx, param=param)
names(res)
res[["chr1:1-100000"]][1:2]

## parse 100 records at a time[＃解析一次100条记录]
tbx <- open(TabixFile(fl))
while(length(res <- yieldTabix(tbx, yieldSize=100L)))
   cat("records read:", length(res), "\n")
close(tbx)


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


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