data_fetcher_batch: Batch Fetch RCSB PDB Data with Optional Retry and Cache

View source: R/batch_cache_api.R

data_fetcher_batchR Documentation

Batch Fetch RCSB PDB Data with Optional Retry and Cache

Description

This additive helper retrieves data in batches and can retry failed batches. Caching is optional and disabled by default, preserving existing package behavior.

Usage

data_fetcher_batch(
  id,
  data_type = "ENTRY",
  properties,
  return_as_dataframe = TRUE,
  batch_size = 50,
  retry_attempts = 3,
  retry_backoff = 0.5,
  progress = FALSE,
  cache = FALSE,
  cache_dir = NULL,
  verbosity = FALSE
)

Arguments

id

Character vector of identifiers.

data_type

Data type passed to data_fetcher().

properties

Property list passed to data_fetcher().

return_as_dataframe

Logical; passed through to data_fetcher().

batch_size

Number of IDs per batch.

retry_attempts

Number of retry attempts per batch.

retry_backoff

Backoff multiplier in seconds.

progress

Logical; show progress messages when TRUE.

cache

Logical; enable on-disk cache.

cache_dir

Optional cache directory.

verbosity

Logical; passed to data_fetcher().

Value

A combined object matching the chosen return mode with provenance metadata.


rPDBapi documentation built on March 9, 2026, 5:08 p.m.