Package index

Screen files

screen_csv(): Run all checks against files

screen_dfs(): Run all checks against data and metadata

screen_filenames(): Run all checks against filenames

Example datasets

example_api_long: Example data that has a column name too long for the API

example_api_long_meta: Example metadata that has a column name too long for the API

example_data: Example data

example_filter_group: Example filter group data

example_filter_group_meta: Example filter group metadata

example_filter_group_wrow: Example filter group with extra row data

example_filter_group_wrow_meta: Example filter group metadata with extra row

example_meta: Example metadata

Generate test files

generate_test_dfs(): EES-ily generate some beefy test files

Reference values

Objects containing required, acceptable, or reference values, e.g. mandatory column names

req_data_cols: Required data columns

req_meta_cols: Required metadata columns

optional_meta_cols: Optional metadata columns

acceptable_time_ids: Acceptable time identifiers

geography_df: Acceptable geographic levels and their associated columns

api_char_limits: API character limits

Filename checks

check_filename_spaces(): Check for spaces in filename

check_filename_special(): Check for special characters in filename

check_filenames_match(): Check filenames line up between data and metadata files

Pre-check necessary columns exist

Ensure the mandatory columns are present before running other checks on the files.

precheck_col_invalid_meta(): Check there are no invalid columns in the metadata

precheck_col_req_data(): Check all required columns are present in data

precheck_col_req_meta(): Check all required columns are present in metadata

precheck_col_to_rows(): Quick check of data columns vs metadata rows

Pre-checks on metadata

These checks should be run before any other metadata checks, as they validate core assumptions about the metadata file itself.

precheck_meta_col_name(): Check col_name is completed for all rows

precheck_meta_col_type(): Check col_type entries are valid

precheck_meta_ob_unit(): Check there are no observational units with rows in the metadata

Metadata checks

check_meta_ind_dp_set(): Check indicator_dp is set for all indicator rows

Core data file structure

Checks on column names

General checks

These can be run on any file, regardless of type or structure.

Pre-checks on filters

Pre-checks on time columns

These checks should be run before any other time checks, as they validate core assumptions about the time columns.

Screen files

Example datasets

Generate test files

Reference values

Filename checks

Pre-check necessary columns exist

Pre-checks on metadata

Metadata checks

Core data file structure

Checks on column names

General checks

Pre-checks on filters

Pre-checks on time columns

Pre-checks on geography columns

General data file checks

Filter checks

Indicator checks

Geography checks

Time checks

API specific checks