headerTabix: Retrieve sequence names defined in a tabix file.

Description Usage Arguments Value Author(s) Examples

View source: R/methods-TabixFile.R

Description

This function queries a tabix file, returning the names of the ‘sequences’ used as a key when creating the file.

Usage

1
2
3
headerTabix(file, ...)
## S4 method for signature 'character'
headerTabix(file, ...)

Arguments

file

A character(1) file path or TabixFile instance pointing to a ‘tabix’ file.

...

Additional arguments, currently ignored.

Value

A list(4) of the sequence names, column indicies used to sort the file, the number of lines skipped while indexing, and the comment character used while indexing.

Author(s)

Martin Morgan <mtmorgan@fhcrc.org>.

Examples

1
2
3
fl <- system.file("extdata", "example.gtf.gz", package="Rsamtools",
                  mustWork=TRUE)
headerTabix(fl)

Rsamtools documentation built on May 20, 2017, 10:32 p.m.

Search within the Rsamtools package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.