Resolve #4: audit \dontrun{} usage and add missing examples#33
Merged
Conversation
(bootstrap_vfc): remove \dontrun{}, clarify GEV/LP3 examples
docs(rfa_simulate): fix Expected-mode parameter set, document runtime
Audit of \dontrun{} usage:
- Remove wrappers from aep2stage, stage2aep, bootstrap_vfc, flow_frequency_sampler_expected, hydrograph_setup
- Add @details to stage2aep documenting expected approx() ties warning
- Add inline GEV/LP3 comments to bootstrap_vfc
- Keep wrapper on rfa_simulate with runtime comment
Bug fix: rfa_simulate Expected-mode example used jmd_vfc_parameters (single posterior mode row) where Nbin*Mevent rows are required. Swapped to jmd_bf_parameter_sets across all three modes.
Missing examples: added example and @return to theme_rfar_conceptual (was rendering blank). Internal helpers (interpolate_aep_matrix, interpolate_stage_matrix, stage_frequency_curve) intentionally left unexposed per @Keywords i
danmcgraw94
changed the title
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
1 participant
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.
\dontrun{} audit
aep2stage,stage2aep,bootstrap_vfc,flow_frequency_sampler_expected, andhydrograph_setup@detailstostage2aepdocumenting the expectedapprox()ties warning at reservoir discharge capacity ceilingbootstrap_vfcexamples\dontrun{}onrfa_simulatewith explanatory comment (Expected + Median ~30s, Full ~3-4 hours)Bug fix
rfa_simulateExpected-mode example usedjmd_vfc_parameters(single posterior mode row), but Expected mode requiresNbin * Meventrows. Swapped tojmd_bf_parameter_setsacross all three example modes for consistency.Missing examples
theme_rfar_conceptualwas rendering near-blank — added example,@return, and fleshed-out descriptioninterpolate_aep_matrix,interpolate_stage_matrix, andstage_frequency_curveare@keywords internaland should not appear in user-facing reference; no examples added (pushback on issue scope)@formatrow/column counts onjmd_hydro_may1955(241→121 rows, 2→4 cols),jmd_hydro_pmf(2→4 cols),jmd_hydro_sdf(2→4 cols)Related
ggplot2from Suggests to Imports (called unconditionally intheme_rfar_conceptual)tidyversefrom Suggests (redundant with specific tidyverse packages already listed)Notes from
R CMD checkCONTRIBUTING.mdat top level)bootstrap_vfc(~7.8s) andflow_frequency_sampler_expected(~7.5s) — both demonstrate realistic pipelines and runtime is dominated by the bootstrap step; retained at full sizeCONTRIBUTING.md.Rbuildignorefix handled in separate issueRelated Issue
Resolves #4.