Skip to content

Commit 9f44d43

Browse files
ehrlingerclaude
andcommitted
docs: enable roxygen2 markdown package-wide
Add Roxygen: list(markdown = TRUE) to DESCRIPTION so devtools::document() auto-converts backticks / [fn()] / [pkg::fn()] in source roxygen to \code{} / \link{} / \link[pkg]{} in the generated Rd. Existing Rd-style markup keeps working; both styles now coexist. Saves the manual conversion work the Copilot review on PR #94 flagged. Two source-roxygen edits needed to keep R CMD check clean under markdown: - R/help.R: randomForest[SRC] -> randomForestSRC (markdown read [SRC] as an unfinished link reference, producing a missing-link warning). - R/gg_rfsrc.R::bootstrap_survival: 95\% -> 95% (markdown over-escaped the backslash, producing a malformed Rd with shifted section order). Regenerates all 31 Rd files. No functional or rendered-content change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6756527 commit 9f44d43

35 files changed

Lines changed: 274 additions & 264 deletions

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ Suggests:
5050
callr
5151
VignetteBuilder: quarto
5252
Config/roxygen2/version: 8.0.0
53+
Roxygen: list(markdown = TRUE)

NEWS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ ggRandomForests v2.8.0 (development) — continued
1111
dependency, parametric / nonparametric / causal partial estimators)
1212
from the help page alone, not just the wrapper mechanics. No API or
1313
behavioural change.
14+
* Documentation: enable roxygen2 markdown package-wide via
15+
`Roxygen: list(markdown = TRUE)` in `DESCRIPTION`. New roxygen blocks
16+
can use backticks and `[fn()]` link syntax; existing `\code{}` /
17+
`\link{}` markup keeps working. Two source-roxygen edits to keep
18+
R CMD check clean: `randomForest[SRC]` in `R/help.R` (markdown read
19+
it as an unfinished link) becomes plain `randomForestSRC`; the `95\%`
20+
escape in `R/gg_rfsrc.R::bootstrap_survival` becomes a literal `95%`.
21+
No API or rendered-doc behavioural change beyond the conventions
22+
switch.
1423
* New `gg_isopro()` and `plot.gg_isopro()`: tidy wrapper and ranked-elbow +
1524
density visualisation for `varPro::isopro` isolation-forest anomaly
1625
scores. `plot.gg_isopro()` takes `panel = c("both", "elbow", "density")`

R/gg_rfsrc.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ gg_rfsrc.rfsrc <- function(object, # nolint: cyclocomp_linter
383383
#' @param bs_samples Integer; number of bootstrap resamples.
384384
#' @param level_set Numeric vector of length 2 giving the lower and upper
385385
#' quantile probabilities for the confidence band (e.g. \code{c(0.025, 0.975)}
386-
#' for a 95\% CI).
386+
#' for a 95% CI).
387387
#'
388388
#' @return A \code{data.frame} with one row per unique event time and columns
389389
#' \code{value} (time), \code{lower}, \code{upper}, \code{median}, and

R/help.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@
5858
#'
5959
#' The \code{ggRandomForests} package contains the following data functions:
6060
#' \itemize{
61-
#' \item \code{\link{gg_rfsrc}}: randomForest[SRC] predictions.
62-
#' \item \code{\link{gg_error}}: randomForest[SRC] convergence rate based on
61+
#' \item \code{\link{gg_rfsrc}}: randomForestSRC predictions.
62+
#' \item \code{\link{gg_error}}: randomForestSRC convergence rate based on
6363
#' the OOB error rate.
6464
#' \item \code{\link{gg_roc}}: ROC curves for randomForest classification
6565
#' models.

man/autoplot.gg.Rd

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/bootstrap_survival.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/calc_auc.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/calc_roc.rfsrc.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ggRandomForests-package.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/gg_brier.Rd

Lines changed: 23 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)