schema-validations | R Documentation |
Standardized package functions,in terms of schema checks.
These can be run individually (e.g., checkSchema_SheetNums
), or in
bulk (e.g., checkSchema(template_path = "my/file/path", cop_year = 2022, tool = "Data Pack")
).
checkSchema_SkippedSheets(schema, tool, cop_year)
checkSchema_SheetNums(schema)
checkSchema_SheetNames(schema, filepath_schema)
checkSchema_InvalidDatasets(schema, tool, cop_year)
checkSchema_InvalidColType(schema, tool, cop_year)
checkSchema_InvalidValueType(schema, tool, cop_year)
checkSchema_DataElementSyntax(schema)
checkSchema_COsSyntax(schema)
checkSchema_ValidAges(schema)
checkSchema_ValidSexes(schema)
checkSchema_ValidKPs(schema)
checkSchema_Formulas(schema)
checkSchema(schema, template_path, cop_year, tool)
unPackSchema(
template_path = NULL,
skip = NULL,
tool = "Data Pack Template",
cop_year = NULL
)
schema |
Which datapackr schema to use in guiding this function. If left
|
tool |
Type of tool this function will create or interact with. Either
|
cop_year |
COP Year to use for tailoring functions. Remember, FY22 targets = COP21. |
filepath_schema |
Path to the schema file. |
template_path |
Local filepath to Data Pack template Excel (XLSX) file.
This file MUST NOT have any data validation formats present. If left
|
skip |
Character vector of Sheet Names to label for skipping in schema. |
For lower-level functions, a list of instances of failed tests. For the
higher-level checkSchema
, a list object of lists of failed tests.
checkSchema_SkippedSheets
:
checkSchema_SheetNums
:
checkSchema_SheetNames
:
checkSchema_InvalidDatasets
:
checkSchema_InvalidColType
:
checkSchema_InvalidValueType
:
checkSchema_DSDSyntax
:
checkSchema_TASyntax
:
checkSchema_COsSyntax
:
checkSchema_ValidAges
:
checkSchema_ValidSexes
:
checkSchema_ValidKPs
:
checkSchema_Formulas
:
checkSchema
:
unPackSchema
:
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.