int_sts_element_segment {dataquieR} | R Documentation |
Checks for element set
Description
Depends on dataquieR.ELEMENT_MISSMATCH_CHECKTYPE
option,
see there – # TODO: Rind out, how to document and link
it here using Roxygen
.
Usage
int_sts_element_segment(
study_data,
item_level = "item_level",
label_col,
meta_data = item_level,
meta_data_v2
)
Arguments
study_data |
data.frame the data frame that contains the measurements, mandatory. |
item_level |
data.frame the data frame that contains metadata attributes of study data |
label_col |
variable attribute the name of the column in the metadata with labels of variables |
meta_data |
data.frame old name for |
meta_data_v2 |
character path to workbook like metadata file, see
|
Details
Value
a list with
-
SegmentData
: data frame with the unexpected elements check results. -Segment
: name of the corresponding segment, if applicable,ALL
otherwise -
SegmentTable
: data frame with the unexpected elements check results, used for the data quality report. -Segment
: name of the corresponding segment, if applicable,ALL
otherwise
Examples
## Not run:
study_data <- cars
meta_data <- dataquieR::prep_create_meta(VAR_NAMES = c("speedx", "distx"),
DATA_TYPE = c("integer", "integer"), MISSING_LIST = "|", JUMP_LIST = "|",
STUDY_SEGMENT = c("Intro", "Ex"))
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "none")
int_sts_element_segment(study_data, meta_data)
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "exact")
int_sts_element_segment(study_data, meta_data)
study_data <- cars
meta_data <- dataquieR::prep_create_meta(VAR_NAMES = c("speedx", "distx"),
DATA_TYPE = c("integer", "integer"), MISSING_LIST = "|", JUMP_LIST = "|",
STUDY_SEGMENT = c("Intro", "Intro"))
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "none")
int_sts_element_segment(study_data, meta_data)
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "exact")
int_sts_element_segment(study_data, meta_data)
study_data <- cars
meta_data <- dataquieR::prep_create_meta(VAR_NAMES = c("speed", "distx"),
DATA_TYPE = c("integer", "integer"), MISSING_LIST = "|", JUMP_LIST = "|",
STUDY_SEGMENT = c("Intro", "Intro"))
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "none")
int_sts_element_segment(study_data, meta_data)
options(dataquieR.ELEMENT_MISSMATCH_CHECKTYPE = "exact")
int_sts_element_segment(study_data, meta_data)
## End(Not run)