Skip to contents

Store class using directories and files on a standard file system.

Format

R6::R6Class inheriting from Store.

Details

DirectoryStore for Zarr

See also

Other Store classes: HttpStore, MemoryStore, Store

Super class

pizzarr::Store -> DirectoryStore

Public fields

root

The path to the root of the store.

Methods

Inherited methods


Method new()

Create a new file system store.

Usage

DirectoryStore$new(root)

Arguments

root

The path to the root of the store.

Returns

A new DirectoryStore object.


Method get_item()

Get an item from the store.

Usage

DirectoryStore$get_item(key)

Arguments

key

The item key.

Returns

The item data in a vector of type raw.


Method set_item()

Set an item in the store.

Usage

DirectoryStore$set_item(key, value)

Arguments

key

The item key.

value

The item value as a vector of type raw.

Returns

NULL (called for side effects).


Method contains_item()

Determine whether the store contains an item.

Usage

DirectoryStore$contains_item(key)

Arguments

key

The item key.

Returns

A boolean value.


Method delete_item()

Delete an item from the store.

Usage

DirectoryStore$delete_item(key)

Arguments

key

The item key.

Returns

NULL (called for side effects).


Method rmdir()

Remove a path within a Store.

Usage

DirectoryStore$rmdir(path = NA)

Arguments

path

Character path.

Returns

NULL (called for side effects).


Method listdir()

List the store directory.

Usage

DirectoryStore$listdir(key = NA)

Arguments

key

Character key.

Returns

character() vector of entries.


Method print()

Print a human-readable summary of the store.

Usage

DirectoryStore$print(...)

Arguments

...

Ignored.

Returns

self (invisibly).


Method clone()

The objects of this class are cloneable with this method.

Usage

DirectoryStore$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.