data_proc_elem_evaluate: Generate an assessment report for Data Processing Elements

View source: R/03-harmonized_data_evaluate.R

data_proc_elem_evaluateR Documentation

Generate an assessment report for Data Processing Elements

Description

Assesses the content and structure of a Data Processing Elements object and generates reports of the results. This function can be used to evaluate data structure, presence of specific fields, coherence across elements, and data dictionary formats.

Usage

data_proc_elem_evaluate(data_proc_elem, taxonomy = NULL)

Arguments

data_proc_elem

A Data Processing Elements object.

taxonomy

An optional data frame identifying a variable classification schema.

Details

The Data Processing Elements specifies the input elements and processing algorithms to generate harmonized variables in the DataSchema formats. It is also contains metadata used to generate documentation of the processing. A Data Processing Elements object is a data frame with specific columns used in data processing: dataschema_variable, input_dataset, input_variables, Mlstr_harmo::rule_category and Mlstr_harmo::algorithm. To initiate processing, the first entry must be the creation of a harmonized primary identifier variable (e.g., participant unique ID).

A taxonomy is a classification schema that can be defined for variable attributes. A taxonomy is usually extracted from an Opal environment, and a taxonomy object is a data frame that must contain at least the columns taxonomy, vocabulary, and terms. Additional details about Opal taxonomies are available online.

Value

A list of data frames containing assessment reports.

Examples

{
# Use Rmonize_examples to run examples.
library(dplyr)

data_proc_elem <- Rmonize_examples$`Data_Processing_Elements_no_errors`

glimpse(data_proc_elem)
}


Rmonize documentation built on July 1, 2025, 1:10 a.m.