-
Notifications
You must be signed in to change notification settings - Fork 8
reorganize tests #60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
reorganize tests #60
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # noinst/ | ||
|
|
||
| Tools to generate test code from .RData files. Not included in package. | ||
|
|
||
| ## Files | ||
|
|
||
| - `td0.24.1_R3.2.3_64bit.RData` - Reference results from v0.24.1 for regression testing | ||
| - `data_input_swisspharma.RData` - Historical test data (redundant with `data/swisspharma.RData`) | ||
| - `00_functions.R` - Helper functions for legacy tests | ||
| - `extract_test_data.R` - Example: extract data to R code using `constructive` | ||
| - `generate_test_code.R` - Functions to generate test fixtures | ||
|
|
||
| ## Usage | ||
|
|
||
| Regenerate test fixtures: | ||
| ```r | ||
| source("noinst/generate_test_code.R") | ||
| generate_test_fixtures() | ||
| ``` | ||
|
|
||
| Old tests loaded .RData files and only ran on CI. New tests use inline R code and `skip_on_cran()`, so they run locally and are better organized. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # Example Script: Extract Test Data from .RData Files | ||
| # ===================================================== | ||
| # This script demonstrates how to use the constructive package to generate | ||
| # R code representations of data objects from .RData files. | ||
| # | ||
| # The generated code can then be copied into test files, eliminating the need | ||
| # for external data dependencies. | ||
|
|
||
| library(constructive) | ||
|
|
||
| # Load the reference data | ||
| # ============================================================================ | ||
| load("noinst/data_input_swisspharma.RData") | ||
| load("noinst/td0.24.1_R3.2.3_64bit.RData") | ||
|
|
||
| # Example 1: Generate code for a simple time series | ||
| # ============================================================================ | ||
| cat("\n=== Example 1: sales.a (full object) ===\n") | ||
| construct(sales.a) | ||
|
|
||
| cat("\n\n=== Example 1b: sales.a (first 5 values only) ===\n") | ||
| sales.a.mini <- window(sales.a, end = 1979) | ||
| construct(sales.a.mini) | ||
|
|
||
|
|
||
| # Example 2: Generate code for quarterly exports (subset) | ||
| # ============================================================================ | ||
| cat("\n\n=== Example 2: exports.q (first 2 years = 8 quarters) ===\n") | ||
| exports.q.mini <- window(exports.q, end = c(1976, 4)) | ||
| construct(exports.q.mini) | ||
|
|
||
|
|
||
| # Example 3: Extract specific reference values from old results | ||
| # ============================================================================ | ||
| cat("\n\n=== Example 3: Reference values for regression tests ===\n") | ||
|
|
||
| # Get first 4 values from a few key methods | ||
| ref_subset <- list( | ||
| dencho_p_1 = as.numeric(r$y2q[1:4, "dencho_p_1"]), | ||
| cl_rss_R = as.numeric(r$y2q[1:4, "cl_rss_R"]), | ||
| fer = as.numeric(r$y2q[1:4, "fer"]) | ||
| ) | ||
|
|
||
| construct(ref_subset) | ||
|
|
||
|
|
||
| # Example 4: Generate code with styling | ||
| # ============================================================================ | ||
| cat("\n\n=== Example 4: Formatted with styler ===\n") | ||
|
|
||
| code_text <- construct(sales.a.mini, pipe = "base") | ||
| code_chr <- capture.output(code_text) | ||
| styled_code <- styler::style_text(code_chr) | ||
| cat(paste(styled_code, collapse = "\n")) | ||
|
|
||
|
|
||
| # Example 5: Create a complete test data fixture | ||
| # ============================================================================ | ||
| cat("\n\n=== Example 5: Complete test fixture ===\n") | ||
|
|
||
| test_fixture <- list( | ||
| # Input data (shortened for testing) | ||
| sales_annual = window(sales.a, start = 1975, end = 1979), | ||
| exports_quarterly = window(exports.q, start = c(1975, 1), end = c(1979, 4)), | ||
|
|
||
| # Reference values for key methods (first 4 quarters only) | ||
| reference = list( | ||
| dencho_p_1 = as.numeric(r$y2q[1:4, "dencho_p_1"]), | ||
| cl_rss_R = as.numeric(r$y2q[1:4, "cl_rss_R"]) | ||
| ) | ||
| ) | ||
|
|
||
| construct(test_fixture) | ||
|
|
||
|
|
||
| # Verification: Test that constructed code works | ||
| # ============================================================================ | ||
| cat("\n\n=== Verification ===\n") | ||
|
|
||
| # Reconstruct sales.a from generated code and compare | ||
| sales_reconstructed <- ts( | ||
| c( | ||
| 136.7023, 151.0561, 156.1824, 157.2078, 162.334, 174.5098, | ||
| 188.6881, 199.8403, 209.3044, 217.9514, 226.4858, 236.3158, | ||
| 247.2106, 259.5633, 270.917, 281.0579, 290.1869, 299.3203, | ||
| 307.0203, 316.581, 326.9476, 335.2306, 343.9407, 353.0683, | ||
| 363.5683, 375.2936, 385.3843, 395.0016, 406.2823, 416.0856, | ||
| 425.9923, 436.3003, 446.8336, 458.3336, 469.5836, 481.5003 | ||
| ), | ||
| start = 1975, frequency = 1 | ||
| ) | ||
|
|
||
| cat("sales.a matches reconstructed:", all.equal(sales.a, sales_reconstructed), "\n") | ||
|
|
||
|
|
||
| # Notes | ||
| # ============================================================================ | ||
| cat("\n\n=== Notes ===\n") | ||
| cat("1. Use constructive::construct() to generate R code from objects\n") | ||
| cat("2. Use styler::style_text() to format the generated code nicely\n") | ||
| cat("3. Extract subsets of large objects to keep test files manageable\n") | ||
| cat("4. Verify that constructed code recreates the original object\n") | ||
| cat("5. For tests: prefer data(swisspharma) for built-in data\n") | ||
| cat("6. Only inline small custom fixtures or reference values\n") | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| # Helper Functions to Generate Test Code from .RData Files | ||
| # =========================================================== | ||
| # These functions extract data from .RData files and generate clean, | ||
| # readable R code that can be copied into test files. | ||
|
|
||
| library(constructive) | ||
|
|
||
| #' Generate R code to recreate a time series object | ||
| #' | ||
| #' @param ts_obj A ts object | ||
| #' @param name Optional name for the object (for documentation) | ||
| #' @param max_values Maximum number of values to include (NULL for all) | ||
| #' @param digits Number of digits for rounding (default 10 for high precision) | ||
| #' @return Character vector of formatted R code | ||
| generate_ts_code <- function(ts_obj, name = NULL, max_values = NULL, digits = 10) { | ||
| if (!is.null(max_values) && length(ts_obj) > max_values) { | ||
| ts_obj <- window(ts_obj, end = time(ts_obj)[max_values]) | ||
| } | ||
|
|
||
| # Extract components | ||
| values <- as.numeric(ts_obj) | ||
| freq <- frequency(ts_obj) | ||
| start_time <- start(ts_obj) | ||
|
|
||
| # Round values for cleaner output | ||
| values <- round(values, digits) | ||
|
|
||
| # Format the values nicely - break into lines of ~4 values | ||
| values_per_line <- 4 | ||
| value_lines <- split(values, ceiling(seq_along(values) / values_per_line)) | ||
| value_strings <- sapply(value_lines, function(x) paste(x, collapse = ", ")) | ||
|
|
||
| # Format start parameter | ||
| start_str <- if (length(start_time) == 1) { | ||
| as.character(start_time) | ||
| } else { | ||
| paste0("c(", paste(start_time, collapse = ", "), ")") | ||
| } | ||
|
|
||
| # Build the code | ||
| code <- c( | ||
| if (!is.null(name)) paste0("# ", name), | ||
| "ts(", | ||
| " c(", | ||
| paste0(" ", value_strings, ifelse(seq_along(value_strings) < length(value_strings), ",", "")), | ||
| " ),", | ||
| paste0(" start = ", start_str, ","), | ||
| paste0(" frequency = ", freq), | ||
| ")" | ||
| ) | ||
|
|
||
| return(code) | ||
| } | ||
|
|
||
|
|
||
| #' Generate R code for a list of reference values | ||
| #' | ||
| #' @param value_list Named list of numeric vectors | ||
| #' @param digits Number of digits for rounding | ||
| #' @return Character vector of formatted R code | ||
| generate_list_code <- function(value_list, digits = 10) { | ||
| # Use constructive but with cleaner numeric formatting | ||
| code <- capture.output(construct(lapply(value_list, function(x) round(x, digits)))) | ||
| # Format with styler | ||
| styled <- styler::style_text(code) | ||
| return(as.character(styled)) | ||
| } | ||
|
|
||
|
|
||
| #' Extract reference values from td0.24.1 file for specific methods | ||
| #' | ||
| #' @param methods Character vector of method names | ||
| #' @param n_values Number of values to extract from each method | ||
| #' @param conversion Either "y2q" or "q2m" | ||
| #' @return Named list of reference values | ||
| extract_reference_values <- function(methods, n_values = 10, conversion = "y2q") { | ||
| # Load the reference data | ||
| env <- new.env() | ||
| load("noinst/td0.24.1_R3.2.3_64bit.RData", envir = env) | ||
|
|
||
| # Get the r list and extract the appropriate conversion | ||
| r <- env$r | ||
| result_matrix <- r[[conversion]] | ||
|
|
||
| # Extract values for each method | ||
| ref_values <- lapply(methods, function(method) { | ||
| if (method %in% colnames(result_matrix)) { | ||
| as.numeric(result_matrix[1:min(n_values, nrow(result_matrix)), method]) | ||
| } else { | ||
| warning("Method ", method, " not found in reference data") | ||
| NULL | ||
| } | ||
| }) | ||
| names(ref_values) <- methods | ||
|
|
||
| # Remove NULL entries | ||
| ref_values[!sapply(ref_values, is.null)] | ||
| } | ||
|
|
||
|
|
||
| #' Complete workflow: Extract and format test fixtures | ||
| #' | ||
| #' @param output_file File to write the generated code to | ||
| generate_test_fixtures <- function(output_file = "tests/testthat/helper-fixtures.R") { | ||
| # Load both data files | ||
| load("noinst/data_input_swisspharma.RData") | ||
| load("noinst/td0.24.1_R3.2.3_64bit.RData") | ||
|
|
||
| # Helper functions from 00_functions.R | ||
| source("noinst/00_functions.R") | ||
|
|
||
| output <- c( | ||
| "# Test Fixtures and Helper Functions", | ||
| "# ===================================", | ||
| "# This file contains test data and helper functions.", | ||
| "# Generated automatically from noinst/ data files.", | ||
| "# DO NOT EDIT BY HAND - regenerate using noinst/generate_test_code.R", | ||
| "", | ||
| "# Helper Functions", | ||
| "# ---------------", | ||
| "" | ||
| ) | ||
|
|
||
| # Add the helper functions | ||
| output <- c( | ||
| output, | ||
| "# Function to run all temporal disaggregation methods", | ||
| readLines("noinst/00_functions.R"), | ||
| "", | ||
| "# Reference Values for Regression Tests", | ||
| "# --------------------------------------", | ||
| "# These are expected outputs from tempdisagg v0.24.1 for comparison", | ||
| "" | ||
| ) | ||
|
|
||
| # Extract key reference values (just a few methods, not all 34) | ||
| key_methods <- c( | ||
| "dencho_p_1", "dencho_p_2", | ||
| "cl_rss_R", "cl_log", | ||
| "fer", "lit_rss" | ||
| ) | ||
|
|
||
| output <- c( | ||
| output, | ||
| "# Year to quarter conversion - first 10 values for key methods", | ||
| "reference_y2q <- ", | ||
| generate_list_code(extract_reference_values(key_methods, n_values = 10, conversion = "y2q")), | ||
| "" | ||
| ) | ||
|
|
||
| output <- c( | ||
| output, | ||
| "# Quarter to month conversion - first 10 values for key methods", | ||
| "reference_q2m <- ", | ||
| generate_list_code(extract_reference_values(key_methods, n_values = 10, conversion = "q2m")), | ||
| "" | ||
| ) | ||
|
|
||
| # Write to file | ||
| writeLines(output, output_file) | ||
| cat("Generated test fixtures written to:", output_file, "\n") | ||
|
|
||
| # Format with styler | ||
| styler::style_file(output_file) | ||
| cat("File formatted with styler\n") | ||
| } | ||
|
|
||
|
|
||
| # Example usage | ||
| # ============= | ||
| if (FALSE) { | ||
| # Generate ts code | ||
| load("noinst/data_input_swisspharma.RData") | ||
|
|
||
| cat("=== Small sales.a subset ===\n") | ||
| cat(generate_ts_code(sales.a, "Annual sales", max_values = 10), sep = "\n") | ||
|
|
||
| cat("\n\n=== Reference values ===\n") | ||
| ref_vals <- extract_reference_values(c("dencho_p_1", "cl_rss_R", "fer"), n_values = 5) | ||
| cat(generate_list_code(ref_vals), sep = "\n") | ||
|
|
||
| cat("\n\n=== Generate complete fixtures file ===\n") | ||
| # generate_test_fixtures() | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Mismatched Time Range Breaks Dataset Equality Check
The verification step compares the full
sales.adataset withsales_reconstructed. However,sales_reconstructedis a hardcoded subset (1975-2010), whilesales.ais the complete dataset. This difference in time periods and length means theall.equalcomparison will always fail.