Skip to content
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

check stage may fail when validation results are pushed into the repository #37

Open
zsigmas opened this issue Aug 27, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@zsigmas
Copy link
Contributor

zsigmas commented Aug 27, 2024

These chuncks are run during the checking stage.

val_param_rds <- "../inst/validation/results/val_param.rds"
val_param_rds_exists <- file.exists(val_param_rds)
if (file.exists(val_param_rds)) params <- readRDS(val_param_rds)
if (val_param_rds_exists) {
  res <- knitr::knit_child("../inst/validation/val_report_child.Rmd", quiet = TRUE, envir = environment())
  cat(res, sep = "\n")
} else {
  "No quality control results found"
}

If validation results are pushed in the repo an attempt to read those files will occur and because check happens on the installed package the path will be wrong.

Proposed solutions:

  • Check that validation results are not pushed into the repositories
  • Fail the check if validation results are found in the directory with a clear message. The message provided by the check is quite obscure by default.
  • Include a control in qc.rmd that bypass these chunks when we are checking
@zsigmas zsigmas added the bug Something isn't working label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant