compare_var_structure: Compare Variable Structures Across SL4 and HAR Objects

View source: R/data_summary.R

compare_var_structureR Documentation

Compare Variable Structures Across SL4 and HAR Objects

Description

Compares variable structures across multiple SL4 and HAR datasets to ensure compatibility. Identifies matching and mismatched variable structures, helping users diagnose inconsistencies.

Usage

compare_var_structure(variables = NULL, ..., keep_unique = FALSE)

Arguments

variables

Character vector. Variable names to compare. Use NULL or "ALL" to compare all variables.

...

Named SL4 or HAR objects to compare.

keep_unique

Logical. If TRUE, returns unique variable structures across datasets instead of checking for compatibility. Default is FALSE.

Details

  • Verifies whether variables have consistent structures across multiple datasets.

  • Ensures correct ordering of dimensions and checks for structural compatibility.

  • If keep_unique = TRUE, returns a list of unique variable structures instead of performing a direct comparison.

  • Useful for merging or aligning datasets before further processing.

  • Helps detect differences in variable dimensions, which may arise due to model updates or dataset variations.

Value

A list containing:

  • match: A data frame listing variables with identical structures across datasets.

  • diff: A data frame listing variables with mismatched structures, useful for debugging and alignment.

  • If keep_unique = TRUE, instead of match and diff, returns a data frame with distinct variable structures across datasets.

Author(s)

Pattawee Puangchit

See Also

get_var_structure, get_dim_patterns, get_dim_elements

Examples

# Import sample data:
har_data1 <- load_harx(system.file("extdata", "TAR10-WEL.har", package = "HARplus"))
har_data2 <- load_harx(system.file("extdata", "SUBT10-WEL.har", package = "HARplus"))

# Compare structure for a single variable across multiple datasets
compare_var_structure("A", har_data1, har_data2)

# Compare structure for multiple variables across multiple datasets
comparison_multiple <- compare_var_structure(c("A", "E1"), har_data1, har_data2)

# Extract unique variable structures across multiple datasets
unique_vars <- compare_var_structure("ALL", har_data1, har_data2, keep_unique = TRUE)


HARplus documentation built on April 4, 2025, 4:14 a.m.