Skip to contents

Check the integrity of RData / qs2 / rds / feather files

Source: R/General_CheckData.R
Check_data.Rd

These functions validate a given file by checking its extension and attempting to load its contents. A file is considered valid if it loads successfully and contains a non-null object, returning TRUE. Otherwise, it returns FALSE.

Usage

CheckData(File, warning = TRUE, nthreads = 5)

CheckRData(File, warning = TRUE)

CheckQs(File, warning = TRUE, nthreads = 5)

CheckRDS(File, warning = TRUE)

CheckFeather(File, warning = TRUE)

Arguments

File

Character. The path to the file to be checked. Cannot be empty.

warning

Logical. If TRUE (default), warnings will be printed if the file does not exist.

nthreads

Integer. The number of threads to use when reading qs2 files. Default is 5.

Value

Logical. TRUE if the file is valid, otherwise FALSE.

Details

The CheckData() function determines the file type based on its extension. If the extension is unrecognized, it returns FALSE. Supported file types:

  • RData: Checked with CheckRData(), read using LoadAs

  • qs2: Checked with CheckQs(), read using qs2::qs_read

  • rds: Checked with CheckRDS(), read using readRDS

  • feather: Checked with CheckFeather(), read using arrow::read_feather

Author

Ahmed El-Gabbas