ZarrGroup Class

Instantiate a group from an initialized store.

Details

The Zarr Group class.

Methods

Public methods

• ZarrGroup$new()

• ZarrGroup$get_store()

• ZarrGroup$get_path()

• ZarrGroup$get_meta()

• ZarrGroup$get_name()

• ZarrGroup$get_read_only()

• ZarrGroup$get_chunk_store()

• ZarrGroup$get_synchronizer()

• ZarrGroup$get_attrs()

• ZarrGroup$contains_item()

• ZarrGroup$get_item()

• ZarrGroup$create_group()

• ZarrGroup$create_dataset()

• ZarrGroup$clone()

---

Method new()

Create a new ZarrGroup instance.

Usage

ZarrGroup$new(
  store,
  path = NA,
  read_only = FALSE,
  chunk_store = NA,
  cache_attrs = TRUE,
  synchronizer = NA
)

Arguments

store

Group store, already initialized.

path

character path

read_only

logical read only?

chunk_store

TODO

cache_attrs

logical cache attributes?

synchronizer

TODO

cache_metadata

logical cache metadata?

Returns

A ZarrGroup instance.

---

Method get_store()

Get group store

Usage

ZarrGroup$get_store()

---

Method get_path()

Get group path

Usage

ZarrGroup$get_path()

---

Method get_meta()

Get group metadata

Usage

ZarrGroup$get_meta()

---

Method get_name()

Get group name

Usage

ZarrGroup$get_name()

---

Method get_read_only()

Is store read only?

Usage

ZarrGroup$get_read_only()

---

Method get_chunk_store()

Get group chunk store

Usage

ZarrGroup$get_chunk_store()

---

Method get_synchronizer()

Get group synchronizer

Usage

ZarrGroup$get_synchronizer()

---

Method get_attrs()

Get group attributes

Usage

ZarrGroup$get_attrs()

---

Method contains_item()

Test for group membership.

Usage

ZarrGroup$contains_item(item)

Arguments

item

character item to test for

---

Method get_item()

Obtain a group member.

Usage

ZarrGroup$get_item(item)

Arguments

item

character item to test for

---

Method create_group()

greate a group

Usage

ZarrGroup$create_group(name, overwrite = FALSE)

Arguments

name

character group name

overwrite

logical overwrite?

---

Method create_dataset()

Usage

ZarrGroup$create_dataset(name, data = NA, ...)

Arguments

name

character group name

data

data to add to group

...

Extra arguments to pass to zarr_create() or array().

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ZarrGroup$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.