Skip to contents

Defines versioned benchmark dataset records and provides deterministic cache resolution, SHA256 verification, atomic fetch-on-demand, offline reuse, catalogue filtering, and conversion to benchmark dataset loaders.

Usage

new_benchmark_dataset_entry(id, version = "1", scale = "tiny",
  source_type = c("embedded", "local", "remote"), filename,
  checksum = NA_character_, source, organism = "unspecified",
  analyses = character(), required_software = character(),
  estimated_runtime_seconds = NA_real_, estimated_memory_mb = NA_real_,
  published = TRUE, metadata = list())

validate_benchmark_dataset_entry(x)
new_benchmark_dataset_catalogue(entries = list())
register_benchmark_dataset(catalogue, entry)
list_benchmark_datasets(catalogue, scale = NULL, organism = NULL,
  analysis = NULL, source_type = NULL)
benchmark_dataset_cache_dir(cache_dir = NULL)
verify_benchmark_dataset(path, checksum = NA_character_)
resolve_benchmark_dataset(entry, cache_dir = NULL, offline = FALSE,
  force = FALSE, quiet = TRUE)
benchmark_dataset_from_entry(entry, cache_dir = NULL, offline = FALSE,
  reader = function(path) readRDS(path))
default_benchmark_dataset_catalogue()

Arguments

id

Stable dataset identifier.

version

Dataset release version.

scale

Dataset scale.

source_type

Embedded, local, or remote source.

filename

File name used within the cache.

checksum

Expected SHA256 checksum.

source

Materializer function, local path, or remote URL.

organism

Organism label.

analyses

Supported analysis identifiers.

required_software

External software annotations.

estimated_runtime_seconds, estimated_memory_mb

Resource estimates.

published

Whether a remote entry is available.

metadata

Additional named metadata.

x

Dataset entry to validate.

entries

Initial catalogue entries.

catalogue

Dataset catalogue.

entry

Dataset entry.

analysis

Optional analysis filter.

cache_dir

Optional cache root.

path

Dataset file path.

offline

Disable remote access.

force

Refresh a valid cached file.

quiet

Suppress download progress.

reader

Function reading the cached file.

Value

Canonical dataset entries or catalogues, filtered data tables, verified cache paths, or benchmark datasets.