Cross-link the docs, add a citation section and flesh out the site - #90
Merged
Merged
Conversation
- Add @family / @Seealso cross-references between the four exported functions so their help pages link to each other. - Add a "Citation" section to the README pointing at citation("LAGOtrials"), the Bing et al. (2025) methods paper, and CITATION.cff. - Flesh out the pkgdown config (authors, navbar github link, news) and build favicons from the hex logo.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
What this changes
Small documentation and site polish (no behavior change).
@family LAGO functions/@seealsobetween
lago_optimization(),get_confidence_set(),visualize_cost()andlago_report(), so each help page links to the others.citation("LAGOtrials"), the Bing etal. (2025) Biometrics methods paper, and
CITATION.cff.authors, a navbar GitHub link, andnewsconfig,and built favicons from the hex logo.
Regenerates the four affected
man/*.Rd.NAMESPACEunchanged;pkgdown::check_pkgdown()reports no problems.Related issue
Closes #
Checklist
tests/testthat/— n/a, documentation/site only, no code behavior changedevtools::document()run (regenerated the fourman/*.Rdfor the new cross-references)devtools::check()passes locally — n/a forpkgdown//_pkgdown.yml(build-ignored);check_pkgdown()cleanNEWS.mdupdated — n/a, not a user-facing package change