meta_data

Functions to generate the meta csv file for local cached dataset.

Usage

meta_data(dir = "", cleanup = FALSE, checkData = TRUE)

Arguments

dir

The path to the shared data folder.

cleanup

If remove any invalid intermediate files. Default is FALSE. In cases one data recipe (with same parameter values) was evaluated multiple times, the same data file(s) will match to multiple intermediate files (e.g., .yml). cleanup will remove older intermediate files, and only keep the most recent ones that matches the data file. When there are any intermediate files that don't match to any data file, cleanup will also remove those.

checkData

check if the data (listed as "# output: " in the yml file) exists. If not, do not include in the output csv file. This argument is added for internal testing purpose.

Value

a data.frame with yml file name, parameter values, data file paths, date, and user-specified notes when generating the data with getData().

Examples

outdir <- file.path(tempdir(), "SharedData")
meta_data(outdir)
#> [1] yml    params output notes  date   <NA>  
#> <0 rows> (or 0-length row.names)