Description Usage Arguments Details Value Examples
View source: R/prep_check_meta_names.R
This function verifies, if a data frame complies to meta data conventions and
provides a given richness of meta information as specified by level
.
1 | prep_check_meta_names(meta_data, level, character.only = FALSE)
|
meta_data |
data.frame the data frame that contains metadata attributes of study data |
level |
enum level of requirement (see also VARATT_REQUIRE_LEVELS) |
character.only |
logical a logical indicating whether level can be assumed to be character strings. |
Note, that only the given level is checked despite, levels are somehow hierarchical.
a logical with:
invisible(TRUE). In case of problems with the meta data, a condition is
raised (stop()
).
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 | prep_check_meta_names(data.frame(VAR_NAMES = 1, DATA_TYPE = 2,
MISSING_LIST = 3))
prep_check_meta_names(
data.frame(
VAR_NAMES = 1, DATA_TYPE = 2, MISSING_LIST = 3,
LABEL = "LABEL", VALUE_LABELS = "VALUE_LABELS",
JUMP_LIST = "JUMP_LIST", HARD_LIMITS = "HARD_LIMITS",
KEY_OBSERVER = "KEY_OBSERVER", KEY_DEVICE = "KEY_DEVICE",
KEY_DATETIME = "KEY_DATETIME",
KEY_STUDY_SEGMENT = "KEY_STUDY_SEGMENT"
),
RECOMMENDED
)
prep_check_meta_names(
data.frame(
VAR_NAMES = 1, DATA_TYPE = 2, MISSING_LIST = 3,
LABEL = "LABEL", VALUE_LABELS = "VALUE_LABELS",
JUMP_LIST = "JUMP_LIST", HARD_LIMITS = "HARD_LIMITS",
KEY_OBSERVER = "KEY_OBSERVER", KEY_DEVICE = "KEY_DEVICE",
KEY_DATETIME = "KEY_DATETIME", KEY_STUDY_SEGMENT =
"KEY_STUDY_SEGMENT",
DETECTION_LIMITS = "DETECTION_LIMITS", SOFT_LIMITS = "SOFT_LIMITS",
CONTRADICTIONS = "CONTRADICTIONS", DISTRIBUTION = "DISTRIBUTION",
DECIMALS = "DECIMALS", VARIABLE_ROLE = "VARIABLE_ROLE",
DATA_ENTRY_TYPE = "DATA_ENTRY_TYPE",
VARIABLE_ORDER = "VARIABLE_ORDER", LONG_LABEL =
"LONG_LABEL", recode = "recode"
),
OPTIONAL
)
# Next one will fail
try(
prep_check_meta_names(data.frame(VAR_NAMES = 1, DATA_TYPE = 2,
MISSING_LIST = 3), TECHNICAL)
)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.