Improve package documentation, structure, and pkgdown site - #28
Merged
Conversation
DESCRIPTION: - Add additional authors - Correct repository and bug-reporting URLs DOCUMENTATION: - Move illustrations folder from inst/ to vignettes/ - Add custom CSS for figure styling - Switch from knitr R-style figure generation to markdown syntax - Ensure responsive images with max-width: 750px and centered alignment
- Add pkgdown configuration with _pkgdown.yml - Set up documentation website structure and theme - Update roxygen2 to version 8.0.0 in DESCRIPTION - Re-document all functions with latest roxygen2 - Rename vignettes for better pkgdown navigation: - `get-started` → `pviem` (enables "Get started" navbar entry) - `data-requirements` → `data` (simplified naming) - Minor content and formatting improvements to vignettes
Add missing @Keywords internal tags to internal functions so they no longer appear in the pkgdown reference page.
- standardize R source and test filenames - clarify API, return-value, and dataset documentation - improve package metadata and vignette configuration - fix minor style and documentation issues - regenerate Rd reference files
- distinguish empirical intervals from confidence intervals - update plots to show quantiles across imputation samples - clarify rho assumptions for overlapping vaccine uptake - improve data requirements and efficacy provenance notes - refine README and vignette navigation
olivieradjagba
changed the title
olivieradjagba
added
documentation
Rename snapshot files to match the hyphenated test filenames.
- change the administrative identifier separator from `__` to `:::` - update documentation and snapshots for the new separator - apply minor assignment-style cleanup - add a GitHub release notes template
olivieradjagba
marked this pull request as ready for review
July 22, 2026 14:36
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.
Description
This PR updates the package following version 0.2.2, with a focus on documentation, consistency, and release maintenance.
The main changes are:
__to:::.Migration note
Generated administrative identifiers that previously used
__now use:::. Code or stored data that creates, compares, or parses these identifiers must be updated accordingly.Related issues
None.
Type of change
Checklist
devtools::check())