Skip to content

Update README and _pkgdown.yml for improved documentation and badge v…#65

Merged
ehrlinger merged 1 commit into
mainfrom
pkgdown-site
Mar 17, 2026
Merged

Update README and _pkgdown.yml for improved documentation and badge v…#65
ehrlinger merged 1 commit into
mainfrom
pkgdown-site

Conversation

@ehrlinger
Copy link
Copy Markdown
Owner

This pull request updates the documentation and configuration for the ggRandomForests package website, focusing on improving badge displays, updating URLs, and enhancing the package reference organization in the site navigation.

Documentation and badge improvements:

  • Added a new badge to the README.md to display the R package version from GitHub.
  • Updated the badges shown in the pkgdown site sidebar to include CRAN version, development version, R-CMD-check, Codecov coverage, CRAN downloads, and DOI, and changed the badge section title to "Package status".

Website configuration and navigation:

  • Changed the site URL in _pkgdown.yml to use HTTPS.
  • Improved the sidebar and navbar structure, adding a "dev" section and reorganizing navigation items for clarity.
  • Added a detailed reference section in _pkgdown.yml, grouping package functions by theme (e.g., Forest Objects, Training Error, Variable Importance, Survival Analysis, Utilities), and added articles and news sections for better documentation and release tracking.…isibility

@ehrlinger ehrlinger merged commit 4dc789c into main Mar 17, 2026
14 checks passed
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.37%. Comparing base (8e3251b) to head (96f0b97).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #65   +/-   ##
=======================================
  Coverage   83.37%   83.37%           
=======================================
  Files          23       23           
  Lines        1816     1816           
=======================================
  Hits         1514     1514           
  Misses        302      302           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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