cache_info: Cache information

View source: R/load_data_external.R

cache_infoR Documentation

Cache information

Description

[Experimental]

Displays information about cached simulation data (~150 MB) used by plan_sample_size(). Shows the cache directory location, whether data is cached, file size, and dataset version metadata.

The simulation data is automatically downloaded on first use of sample size planning functions and stored locally for faster subsequent access.

Usage

cache_info()

Value

Invisibly returns a list with:

  • cache_dir: Character string with the cache directory path

  • data_cached: Logical indicating if simulation data is cached

  • file_size_mb: Numeric file size in MB (or NA if not cached)

  • data_version: GitHub release tag of the cached dataset (or NA if not cached)

  • data_created: Date the dataset was created (or NA if not cached)

See Also

  • cache_clear() to remove cached data

  • download_sample_size_data() to manually download simulation data

  • plan_sample_size() which uses the cached data


sprtt documentation built on May 6, 2026, 5:06 p.m.