bifrost_example_file: Locate a verified empirical example-data artifact

View source: R/example-data.R

bifrost_example_fileR Documentation

Locate a verified empirical example-data artifact

Description

Resolves a named empirical artifact to a locally verified file. A directory supplied through BIFROST_ARTIFACT_DIR always takes precedence, including when refresh = TRUE. With no verified cache entry, the first request uses the manifest and artifact currently tracked on GitHub main. Later calls reuse the verified cache and work offline; use refresh = TRUE to check main again. The returned value is a path; this function does not deserialize the file.

Usage

bifrost_example_file(name, refresh = FALSE, quiet = FALSE)

Arguments

name

A registered example-data identifier.

refresh

Whether to bypass the cached manifest and check the remote manifest for a newer artifact.

quiet

Whether downloads should suppress progress output.

Value

A normalized path to the checksum-verified artifact.

Examples

## Not run: 
bifrost_example_file("jaw-tree")
bifrost_example_file("jaw-tree", refresh = TRUE)

## End(Not run)

bifrost documentation built on Nov. 5, 2026, 9:07 a.m.