Phase 5:feat(benchmark): add validation framework tutorial vignette (#4076) - #4087
Merged
Merged
Conversation
ayushman1210
force-pushed
the
phase-5
branch
from
September 1, 2026 08:48
281dcb2 to
2cc87b3
Compare
ayushman1210
force-pushed
the
phase-5
branch
from
September 1, 2026 08:57
2cc87b3 to
0ca92d0
Compare
divine7022
reviewed
Sep 14, 2026
divine7022
left a comment
Member
There was a problem hiding this comment.
thanks @ayushman1210 ! took first pass; vignette reads well, schema section and the mean vs ensemble split are the parts I would keep as is. but CI still fails probable fix I have dropped below.
divine7022
reviewed
Sep 16, 2026
divine7022
approved these changes
Sep 16, 2026
divine7022
left a comment
Member
There was a problem hiding this comment.
thanks for putting this together!,
one thing i never actually dropped on you, sorry, of examples/benchmarks/ameriflux/,
real ensemble is the upstream dependency and i think that's still where we are. can this run_ameriflux_benchmark.R come out of this PR and come back with the ensemble ? the simulated fixtures stay either way since the vignette uses them now.
fine as a follow up -- just reporting here
i will defer this to @dlebauer
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Resolves #4076 (Phase 5 GSoC Benchmarking & Validation Milestone) by creating a comprehensive tutorial vignette for the
PEcAn.benchmarkpackage. The vignette explains and demonstrates the complete end-to-end benchmarking workflow, data intake schemas, statistical error model formulations, temporal alignment, metric evaluation, diagnostic visualizations, and automated Quarto scorecard rendering.Key Changes
1. Tutorial Vignette (
modules/benchmark/vignettes/validation_framework_tutorial.Rmd)datetime,site_id,parameter,variable,prediction) and observation formats.efi_long_to_array()and temporal alignment viaalign_by_time().RMSE,BIAS,MAE,R2) from spread metrics on the full ensemble (COVERAGE,CRPS).metric_timeseries_plot), scatter plots (metric_scatter_plot), and residual plots (metric_residual_plot).2. Package Configuration (
modules/benchmark/DESCRIPTION)VignetteBuilder: knitr.knitrandrmarkdowntoSuggests.3. Unit Test Coverage (
modules/benchmark/tests/testthat/test-vignette_execution.R)Verification & Testing
Rendered
validation_framework_tutorial.Rmdusingrmarkdown::render()without any errors or warnings.Ran
devtools::test("modules/benchmark"):[ FAIL 0 | WARN 0 | SKIP 1 | PASS 136 ](All 136 package tests passing).Related Issue
Closes #4076