delete_example_data: Delete cached Figshare example files

View source: R/utils.R

delete_example_dataR Documentation

Delete cached Figshare example files

Description

Removes only the known example filenames produced by [get_example_data()] under 'data_dir'. Paths are never taken from [options()], so unrelated files cannot be deleted by mistake. Deletion is only allowed when 'data_dir' is the session example cache ([example_data_folder()]), the legacy per-user 'tools::R_user_dir("gimap", "data")', or any directory under [tempdir()] (for example test directories).

Usage

delete_example_data(data_dir = NULL)

Arguments

data_dir

Directory whose example files should be removed. The default ('NULL') uses the same session cache as [get_example_data()].

Value

Invisibly, the character vector of file paths that were removed (may be length zero if nothing existed).

Examples

delete_example_data()


gimap documentation built on July 10, 2026, 1:06 a.m.