BORG (version 0.2.5)

summary.BorgDiagnosis: Summarize BORG Diagnosis

Description

Generate a methods section summary for publication from a BorgDiagnosis object.

Usage

# S3 method for BorgDiagnosis
summary(
  object,
  comparison = NULL,
  v = 5,
  style = c("apa", "nature", "ecology"),
  include_citation = TRUE,
  ...
)

Value

Character string with methods section text (invisibly). Also prints the text to the console.

Arguments

object

A BorgDiagnosis object.

comparison

Optional. A borg_comparison object from borg_compare_cv() to include empirical inflation estimates.

v

Integer. Number of CV folds used. Default: 5.

style

Character. Citation style: "apa" (default), "nature", "ecology".

include_citation

Logical. Include BORG package citation. Default: TRUE.

...

Additional arguments (currently unused).

Examples

set.seed(42)
data <- data.frame(
  x = runif(100, 0, 100),
  y = runif(100, 0, 100),
  response = rnorm(100)
)
diagnosis <- borg_diagnose(data, coords = c("x", "y"), target = "response",
                           verbose = FALSE)
summary(diagnosis)