BORG (version 0.2.5)

borg_export: Export Validation Certificate

Description

Write a BORG validation certificate to a YAML or JSON file for machine-readable documentation.

Usage

borg_export(diagnosis, data, file, comparison = NULL, cv = NULL)

Value

Invisibly returns the certificate object.

Arguments

diagnosis

A BorgDiagnosis object.

data

The data frame that was analyzed.

file

Character. Output file path. Extension determines format (.yaml/.yml for YAML, .json for JSON).

comparison

Optional. A borg_comparison object.

cv

Optional. A borg_cv object.

See Also

borg_certificate for creating certificates.

Examples

# \donttest{
spatial_data <- data.frame(
  x = runif(100), y = runif(100), response = rnorm(100)
)
diagnosis <- borg_diagnose(spatial_data, coords = c("x", "y"), target = "response")
borg_export(diagnosis, spatial_data, file.path(tempdir(), "validation.yaml"))
borg_export(diagnosis, spatial_data, file.path(tempdir(), "validation.json"))
# }