The iSEEindexLocalhostResource class

The iSEEindexLocalhostResource class represents a resource accessible through a local filepath. A URI for this type of resource uses the prefix “localhost://”.

Usage

iSEEindexLocalhostResource(x)

Arguments

x

List of metadata. See Details.

Value

The constructor function iSEEindexLocalhostResource() returns an object of object of class iSEEindexLocalhostResource.

Details

Required metadata:

uri

Character scalar. URI of the resource.

Slot overview

This class inherits all slots from its parent class iSEEindexResource.

Supported methods

In the following code snippets, x is an instance of a iSEEindexLocalhostResource class. Refer to the documentation for each method for more details on the remaining arguments.

• precache(x, ...) trims the localhost:// prefix, and caches a copy of the resource located at the resulting file path using BiocFileCache, before returning the file path to the cached file.

Absolute and relative paths

Absolute and relative paths are both supported.

Absolute paths require an additional / (forward slash) following the double forward slash // separating the scheme component of the URI.

For instance:

• localhost://path/to/file refers to the relative path path/to/file (relative to the working directory when the Shiny application is launched).

• localhost:///path/to/file refers to the absolute path /path/to/file.

Author

Kevin Rue-Albrecht

Examples

iSEEindexLocalhostResource(list(uri = "localhost:///example/absolute/path"))
#> class: iSEEindexLocalhostResource 
#> - uri: localhost:///example/absolute/path 
iSEEindexLocalhostResource(list(uri = "localhost://example/relative/path"))
#> class: iSEEindexLocalhostResource 
#> - uri: localhost://example/relative/path