Skip to content

README.Rmd: statement of need, feature overview, minimal example and links (#217) - #254

Merged
feralaes merged 1 commit into
mainfrom
217-readme
Nov 14, 2026
Merged

feralaes merged 1 commit into
mainfrom
217-readme

Conversation

@feralaes

Copy link
Copy Markdown
Collaborator

Closes #217.

The README is the landing page on GitHub and CRAN, the home page of the pkgdown site, and one of the first things JOSS reviewers read. It's now generated from README.Rmd, so the example output and figure always come from the current code.

What's in it

Section Contents
Badges CRAN status (new), R-CMD-check, Codecov
Why dampack (new) Statement of need: models produce costs and outcomes, and dampack runs the standard CEA, PSA and VOI analyses on any model's output, whatever language the model is in. Links the DARTH coding framework paper.
What it does (new) One bullet per area: CEA and ICERs, PSA, value of information, DSA, PSA inputs, each naming its main functions.
Installation CRAN and GitHub (now remotes::install_github()), and the macOS locale tip, kept and shortened.
Example (new) cancer_psa_data → make_psa_obj() → calculate_icers_psa() (printed table) → ceac() and its plot, the one figure.
Learn more (new) Links to the website, function reference, the five articles in reading order (with their real titles), and the news page.
Citation (new) citation("dampack"). The JOSS reference can be added once it's published.
Getting help and contributing (new) Issue tracker, contributing guide, code of conduct.
Funding, DARTH team Kept. Fixed: the team section still called David the CRAN maintainer. Fernando is maintainer since #245.

The old README said there were "six vignettes" with five listed; that line is gone.

Notes for reviewers

Verification

…e and links (#217)

- README.md is now generated from README.Rmd (devtools::build_readme()); README.Rmd is
  build-ignored, README.md and its one figure (man/figures/README-ceac-1.png, ragg, 48 KB)
  are kept for GitHub, CRAN and pkgdown.
- New sections: why dampack (statement of need), what it does, a runnable example with
  cancer_psa_data (calculate_icers_psa() output and a CEAC figure), learn more (website,
  reference, articles in reading order, news), citation, getting help and contributing
  (issues, CONTRIBUTING, code of conduct). CRAN status badge added.
- Kept: installation (now with remotes), the macOS locale tip, funding, the DARTH team.
- The team section listed David Garibay as CRAN maintainer; Fernando is maintainer since #245.
@feralaes
feralaes merged commit abee512 into main Nov 14, 2026
13 checks passed
@feralaes
feralaes deleted the 217-readme branch November 14, 2026 03:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README.Rmd with statement of need, minimal example and badges

1 participant