Users currently have to jump from the JMD example walkthrough in the README to setting up their own project with no guided transition. A getting-started vignette would bridge this gap.
Scope
Lightweight R Markdown vignette using eval = FALSE on any heavy computation (rfa_simulate(), etc.) so it stays fast and builds cleanly under R CMD check.
Suggested structure:
- Prerequisites (inputs needed: hydrographs, reservoir table, parameters)
- Suggested project layout (e.g.,
data/hydrographs/, scripts/, rfaR_results/)
- Reading your inputs — CSV gotchas
- Numeric columns (commas, type coercion)
- Empirical stage CSV format (column A is Ordinate, water year has to be constructed manually)
- Running a simulation conceptually (non-executing code block)
- Plotting results
Feedback source
Raised by Allen (comments #3, #4, #6, #7).
Users currently have to jump from the JMD example walkthrough in the README to setting up their own project with no guided transition. A getting-started vignette would bridge this gap.
Scope
Lightweight R Markdown vignette using
eval = FALSEon any heavy computation (rfa_simulate(), etc.) so it stays fast and builds cleanly underR CMD check.Suggested structure:
data/hydrographs/,scripts/,rfaR_results/)Feedback source
Raised by Allen (comments #3, #4, #6, #7).