Repository navigation
README.Rmd: statement of need, feature overview, minimal example and links (#217) - #254
Merged
Merged
Conversation
…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.
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.
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
remotes::install_github()), and the macOS locale tip, kept and shortened.cancer_psa_data→make_psa_obj()→calculate_icers_psa()(printed table) →ceac()and its plot, the one figure.citation("dampack"). The JOSS reference can be added once it's published.The old README said there were "six vignettes" with five listed; that line is gone.
Notes for reviewers
maintoday, so the README stays accurate. Once Compare strategies with a reference in calculate_icers() and print.icers() (#209, #200) #227 merges, one bullet about presenting results against a reference strategy (ref_str, NMB) should be added. I'll do that as a follow-up.ceac(l_psa, wtp = v_wtp), which works both before and after the argument-order change in Harmonize the API with soft deprecation: ceac(psa, wtp), linewidth, axis limits, effect_units (#214) #251.README.Rmd, notREADME.md, then rundevtools::build_readme(). The first line of README.md says so too.Verification
devtools::build_readme(). Every link in the new sections returns HTTP 200.R CMD check --as-cran: only the development-version NOTE, and the installed size is still OK.