RsamtoolsFile {Rsamtools} | R Documentation |
RsamtoolsFile
is a base class for managing file references in
Rsamtools; it is not intended for direct use by users – see, e.g.,
BamFile
.
## accessors index(object) ## S4 method for signature 'RsamtoolsFile' path(object, ...) ## S4 method for signature 'RsamtoolsFile' isOpen(con, rw="") ## S4 method for signature 'RsamtoolsFile' show(object)
con, object |
An instance of a class derived from |
rw |
Mode of file; ignored. |
... |
Additional arguments, unused. |
Users do not directly create instances of this class; see, e.g.,
BamFile-class
.
The RsamtoolsFile
class is implemented as an S4 reference
class. It has the following fields:
An externalptr
initialized to an internal
structure with opened bam file and bam index pointers.
A character(1) vector of the file name.
A character(1) vector of the index file name.
Accessors:
Returns a character(1) vector of BAM path names.
Returns a character(1) vector of BAM index path names.
Methods:
Report whether the file is currently open.
Compactly display the object.
Martin Morgan