Datamonger for R · r · 0.0.0.9000

Retrieve or Inspect Registered Data

fetch_artifact

Source: packages/r/R/api.R, packages/r/man/data.Rd

Resolve a dataset within one strongly selected registry. Artifact size and SHA-256 verification cannot be disabled. Decoded verification is enabled by default and may be disabled only explicitly.

Usage

fetch_data(name, source = NULL, version = NULL, registry = NULL, cache_dir = NULL,
  offline = FALSE, verify_decoded = TRUE, return_info = FALSE)

fetch_artifact(name, source = NULL, version = NULL, artifact = NULL,
  registry = NULL, cache_dir = NULL, offline = FALSE)

data_info(name, source = NULL, version = NULL, registry = NULL, cache_dir = NULL,
  offline = FALSE)

list_data(registry = NULL, cache_dir = NULL, offline = FALSE)

Arguments

• name

  A bare dataset name, source:name, or source:name@version.

• source

  The dataset source. Required for bare names; omit it for qualified references, even if the values would agree.

• version

  An exact version. Omit it when the reference embeds a version, even if the values would agree. If neither form supplies a version, resolve the registry default.

• artifact

  An artifact name. It may be omitted for a single-artifact dataset.

• registry

  A strong selector, or NULL for the active selector.

• cache_dir

  An explicit cache path, or NULL for the platform default.

• offline

  Whether to forbid all network access.

• verify_decoded

  Whether to verify expected shape and canonical digest.

• return_info

  Whether to return reproducibility metadata with the data.

Value

fetch_data() returns a data frame or a Datamonger sparse result; with return_info = TRUE, it returns a datamonger_fetch_result. fetch_artifact() returns a cache path. Metadata functions return one or a list of datamonger_data_info records. Sparse features use a row-compressed Matrix, or an exact datamonger_csr_matrix when a declared dimension exceeds the Matrix integer limit.

Help topic: fetch_data