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

loveR

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

                                         Compress and index tabix-compatible files.
                                         压缩指数TABIX兼容的文件。

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

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

Index (with indexTabix) files that have been sorted into ascending sequence, start and end position ordering.
指数（以indexTabix）已排序升序序列，开始和结束排序位置的文件。


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



indexTabix(file,
           format=c("gff", "bed", "sam", "vcf", "vcf4", "psltbl"),
           seq=integer(), start=integer(), end=integer(),
           skip=0L, comment="#", zeroBased=FALSE, ...)




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

参数：file
A characater(1) path to a sorted, bgzip-compressed file.
一个characater（1）一个排序，bgzip压缩文件的路径。


参数：format
The format of the data in the compressed file. A characater(1) matching one of the types named in the function signature.
在压缩文件中的数据格式。匹配一个characater（1）在函数签名命名的类型之一。


参数：seq
If format is missing, then seq indicates the column in which the "sequence" identifier (e.g., chrq) is to be found.
format如果丢失，则seq表示“序列”的标识（例如，chrq）被发现列在其中。


参数：start
If format is missing, start indicates the column containing the start coordinate of the feature to be indexed.
format如果丢失，start指示列包含被索引的功能开始坐标。


参数：end
If format is missing, end indicates the column containing the ending coordinate of the feature to be indexed.
format如果丢失，end指示列包含被索引的功能结束坐标。


参数：skip
The number of lines to be skipped at the beginning of the file.
在文件的开头跳过的行数。


参数：comment
A single character which, when present as the first character in a line, indicates that the line is to be omitted. from indexing.
这行的第一个字符时，提出一个单个字符，表示该行是被省略。从索引。


参数：zeroBased
A logical(1) indicating whether coordinats in the file are zero-based.
逻辑（1）指示是否在文件coordinats是从零开始的。


参数：...
Additional arguments.
额外的参数。


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

The return value of indexTabix is an updated instance of file reflecting the newly-created index file.
返回值的indexTabix是file反映了新创建的索引文件的最新实例。


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



Martin Morgan <mtmorgan@fhcrc.org>.




参考文献----------References----------



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


from <- system.file("extdata", "ex1.sam", package="Rsamtools")
to <- tempfile()
zipped <- bgzip(from, to)
idx <- indexTabix(zipped, "sam")

tab <- TabixFile(zipped, idx)
res <- yieldTabix(tab)

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


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