A minimal class to represent Xenium metadata — XeniumFile-class • XeniumIO

This class is a minimal class to represent Xenium metadata. It is dedicated to importing experiment.xenium metadata files. It uses the jsonlite package to import the metadata.

Usage

XeniumFile(resource)

# S4 method for class 'XeniumFile,ANY,ANY'
import(con, format, text, ...)

Arguments

resource: character(1) The path to the Xenium metadata file.
con: The connection from which data is loaded or to which data is saved. If this is a character vector, it is assumed to be a file name and a corresponding file connection is created and then closed after exporting the object. If it is a BiocFile derivative, the data is loaded from or saved to the underlying resource. If missing, the function will return the output as a character vector, rather than writing to a connection.
format: The format of the output. If missing and con is a file name, the format is derived from the file extension. This argument is unnecessary when con is a derivative of BiocFile.
text: If con is missing, this can be a character vector directly providing the string data to import.
...: Parameters to pass to the format-specific method.

Value

A XeniumFile object

Functions

import(con = XeniumFile, format = ANY, text = ANY): Import Xenium metadata

Examples

showClass("XeniumFile")
#> Class "XeniumFile" [package "XeniumIO"]
#> 
#> Slots:
#>                                                                               
#> Name:                extension                  colidx                  rowidx
#> Class:               character                 integer                 integer
#>                                                                               
#> Name:                   remote              compressed                resource
#> Class:                 logical                 logical character_OR_connection
#> 
#> Extends: 
#> Class "TENxFile", directly
#> Class "BiocFile", by class "TENxFile", distance 2