Skip to contents

TENxFile: General purpose class for 10X files

Source: R/TENxFile-class.R
TENxFile-class.Rd

The TENxFile class is the default representation for unrecognized subclasses. It inherits from the BiocFile class and adds a few additional slots. The constructor function can handle typical 10X file types. For more details, see the constructor function documentation.

Usage

# S4 method for class 'TENxFile'
metadata(x, ...)

Arguments

x

An object of class TENxFile, TENxFileList, TENxMTX, TENxH5, TENxPeaks, TENxTSV, or derivatives

...

Additional arguments (not used)

Value

A list of metadata for the given object

Functions

  • metadata(TENxFile): metadata method for TENxFile objects

Slots

extension

character(1) The file extension as extracted from the file path or overridden via the ext argument in the constructor function.

colidx

integer(1) The column index corresponding to the columns in the file that will subsequently be imported

rowidx

integer(1) The row index corresponding to rows in the file that will subsequently be imported

remote

logical(1) Whether the file exists on the web, i.e., the resource is a URL

compressed

logical(1) Whether the file is compressed with, e.g., .gz