Skip to content

Add _pkgdown.yml with organized reference sections#69

Open
keaven wants to merge 1 commit into
tagteam:masterfrom
keaven:add-pkgdown-config
Open

Add _pkgdown.yml with organized reference sections#69
keaven wants to merge 1 commit into
tagteam:masterfrom
keaven:add-pkgdown-config

Conversation

@keaven

@keaven keaven commented Jun 20, 2026

Copy link
Copy Markdown

This PR adds a _pkgdown.yml configuration file that organizes the package's 100+ exported functions into logical, navigable sections on the pkgdown reference page.

Sections

Section Description
Model Fitting CSC, FGR, riskRegression, wglm, GLMnet, etc.
Prediction predictCox, predictRisk, predict.CauseSpecificCox, etc.
Prediction Performance (Score) Score, IPA, getSplitMethod
Average Treatment Effects ate and related methods
Weighted GLM Methods wglm methods
Inference & Influence Functions iidCox, influenceTest, SE/CI functions
Visualization (ggplot2) autoplot methods
Visualization (Base Graphics) plotROC, plotAUC, plotBrier, etc.
Censoring Weights ipcw, subjectWeights
Data Synthesis & Simulation synthesize, sim*, sampleData
Datasets Melanoma, Paquid
Print & Summary Methods print/summary/coef methods
Conversion to data.table as.data.table methods
Cox Model Utilities Low-level cox* helpers
Internal Utilities C++ functions and misc helpers

Additional changes

  • Uses Bootstrap 5 (recommended by pkgdown; BS3 is deprecated)
  • Builds cleanly with pkgdown::build_site()

Notes

  • The url field is set to ~ (placeholder) since no pkgdown deployment URL exists yet
  • Minor warning: hal9001 examples are skipped if the package isn't installed (Suggests dependency)

Adds a pkgdown configuration file that organizes the package's 100+
functions into logical sections:

- Model Fitting
- Prediction
- Prediction Performance (Score)
- Average Treatment Effects
- Weighted GLM Methods
- Inference & Influence Functions
- Visualization (ggplot2 and Base Graphics)
- Censoring Weights
- Data Synthesis & Simulation
- Datasets
- Print & Summary Methods
- Conversion to data.table
- Cox Model Utilities
- Internal Utilities

Also upgrades to Bootstrap 5 (pkgdown recommended).
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.

1 participant