eesyscreener/_pkgdown.yml at main · dfe-analytical-services/eesyscreener · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
url: https://dfe-analytical-services.github.io/eesyscreener/
template:
  bootstrap: 5
  bootswatch: united

reference:
- title: Screen files
  contents:
  - starts_with("screen_")

- title: Data dictionary
  contents:
  - starts_with("data_dictionary")

- title: Example datasets
  contents:
  - starts_with("example_")
  - ees_robot_test_data

- title: Generate test files
  contents:
  - starts_with("generate_")

- title: Reference values
  description: |
    Objects containing required, acceptable, or reference values, e.g. mandatory column names
  contents:
  - starts_with("req_")
  - starts_with("optional_")
  - starts_with("acceptable_")
  - geography_df
  - api_char_limits
  - data_dictionary
  - gss_symbols
  - legacy_gss_symbols
  - four_digit_identifiers
  - six_digit_identifiers
  - potential_ob_units_regex
  - harmonised_col_names

- title: Filename checks
  contents:
  - starts_with("check_filename")

- title: Pre-check necessary columns exist
  description: |
    Ensure the mandatory columns are present before running other checks on the files.
  contents:
  - starts_with("precheck_col_")

- title: Pre-checks across data and metadata
  description: |
    These checks validate consistency between the data file and metadata file.
  contents:
  - starts_with("precheck_cross_")

- title: Pre-checks on metadata
  description: |
    These checks should be run before any other metadata checks, as they validate core assumptions about the metadata file itself.
  contents:
  - starts_with("precheck_meta_")

- title: Metadata checks
  contents:
  - starts_with("check_meta_")

- title: Checks on column names
  description: |
    These checks validate the names of columns in the data files.
  contents:
  - starts_with("check_col_")

- title: General checks
  description: |
    These can be run on any file, regardless of type or structure.
  contents:
  - starts_with("check_general_")

- title: Pre-checks on filters
  description: |
    These checks should be run before any other filter checks, as they validate core assumptions about the filter columns.
  contents:
  - starts_with("precheck_filter_")

- title: Pre-checks on time columns
  description: |
    These checks should be run before any other time checks, as they validate core assumptions about the time columns.
  contents:
  - starts_with("precheck_time_")

- title: Pre-checks on geography columns
  description: |
    These checks should be run before any other geography checks, as they validate core assumptions about the geography columns.
  contents:
  - starts_with("precheck_geog_")

- title: General data file checks

- title: Filter checks
  contents:
  - starts_with("check_filter_")

- title: Indicator checks
  contents:
  - starts_with("check_ind_")

- title: Geography checks
  contents:
  - starts_with("check_geog_")

- title: Time checks
  contents:
  - starts_with("check_time_")

- title: Harmonised variable checks
  description: |
    These checks validate that column names and filter values conform to the
    DfE harmonised data standards.
  contents:
  - starts_with("check_harmonised_")

- title: API specific checks
  contents:
  - starts_with("check_api_")
  - starts_with("check_data_dict_")