qbrms (version 1.0.1)

export_model: Export Model Specification

Description

Export model specifications to various formats for sharing, documentation, or reproduction.

Usage

export_model(
  model,
  file,
  format = c("R", "markdown", "text", "json"),
  include_data = TRUE,
  include_diagnostics = FALSE
)

Value

Invisibly returns the export content as a character string

Arguments

model

A fitted qbrms model object or qbrms_model_spec object

file

Character string specifying output file path

format

Character string specifying export format: "R" (R script), "markdown" (Rmd document), "text" (plain text), or "json" (JSON format)

include_data

Logical; if TRUE, includes data summary in export (default: TRUE)

include_diagnostics

Logical; if TRUE and model is fitted, includes diagnostic information (default: FALSE)

Details

This function facilitates model sharing and documentation by exporting:

• Model formula and family specification

• Prior specifications (if any)

• Data summary and structure

• Model fitting code

• Results summary (for fitted models)

• Diagnostic information (if requested)

The exported content can be used to:

• Share analyses with collaborators

• Document modelling decisions

• Create reproducible research reports

• Archive model specifications

Examples

if (FALSE) {
# Export model specification
spec <- model_builder(data = mtcars, response = "mpg")
export_model(spec, "my_model_spec.R", format = "R")

# Export fitted model
fit <- qbrms(mpg ~ hp + wt, data = mtcars, family = gaussian())
export_model(fit, "my_model.Rmd", format = "markdown", 
             include_diagnostics = TRUE)

# Export as JSON
export_model(spec, "my_model.json", format = "json")
}