Run all checks against files

Run all of the checks in the eesyscreener package against your data file and associated metadata file. It parses the files and runs the checks in four stages, the function will return early if any check in a stage fails.

Usage

screen_files(datafilename, metafilename, datafile, metafile, api_only = FALSE)

Arguments

datafilename

The name of the data file.

metafilename

The name of the metadata file.

datafile

A data frame containing the data file contents.

metafile

A data frame containing the metadata file contents.

api_only

Logical value indicating whether to run only the API checks.

Value

A list containing

1. A table with the full results of the checks with four columns:

   • result of the check (PASS / FAIL / ADVISORY)

   • message giving feedback about the check

   • stage that the check belongs to

   • name of the check

2. Overall stage the checks reached

3. Overall message to give back to the user

Examples

screen_files(
  "data.csv",
  "data.meta.csv",
  example_data,
  example_meta
)
#> $results_table
#>                   check result
#> 1 check_filename_spaces   PASS
#> 2 check_filename_spaces   PASS
#> 3      check_empty_cols   PASS
#>                                                 message stage
#> 1      'data.csv' does not have spaces in the filename.     1
#> 2 'data.meta.csv' does not have spaces in the filename.     1
#> 3           'data.csv' does not have any blank columns.     1
#> 
#> $overall_stage
#> [1] "Passed"
#> 
#> $overall_message
#> [1] "Passed all checks"
#>