Package index • BORG

pkgdown/mathjax-config.html

Main Entry Point

Start here

borg(): BORG: Guard Your Model Evaluation

Core Functions

Detailed validation functions

borg_inspect(): Inspect R Objects for Evaluation Risks
borg_validate(): Validate Complete Evaluation Workflow
borg_certificate(): Create Validation Certificate
borg_export(): Export Validation Certificate

Remediation

Automatic pipeline correction

borg_rewrite(): Automatically Rewrite Leaky Evaluation Pipelines

Visualization

Plot and summary methods for BORG objects

plot(<BorgRisk>): Plot BORG Objects
plot(<borg_result>): Plot BORG Result Objects
plot(<borg_comparison>): Plot CV Comparison Results
summary(<BorgRisk>): Summarize BORG Risk Assessment
summary(<BorgDiagnosis>): Summarize BORG Diagnosis
summary(<borg_result>): Summarize BORG Result

Audit Functions

Prediction and CV auditing

audit_predictions(): Audit Predictions for Data Leakage
audit_importance(): Audit Feature Importance Calculations
cv_leakage_report(): Generate CV Leakage Report
borg_cv(): Generate Valid Cross-Validation Scheme
borg_diagnose(): Diagnose Data Dependency Structure
borg_compare_cv(): Compare Random vs Blocked Cross-Validation
show(<BorgDiagnosis>): BorgDiagnosis S4 Class

Framework Integration

Wrappers for ML frameworks

borg-wrappers: BORG-Guarded Cross-Validation Functions
borg_initial_split(): BORG-Guarded initial_split
borg_vfold_cv(): BORG-Guarded vfold_cv
borg_group_vfold_cv(): BORG-Guarded group_vfold_cv
borg_trainControl(): BORG-Guarded trainControl
borg_register_hooks(): Register BORG Hooks
borg_unregister_hooks(): Unregister BORG Hooks

Configuration

Options and settings

borg_auto_check(): Enable/Disable BORG Auto-Check Mode
borg_options(): Get Current BORG Options

Classes

Result objects

show(<BorgRisk>): BorgRisk S4 Class
as.data.frame(<BorgRisk>): Coerce BorgRisk to Data Frame
print(<borg_cv_report>): Print CV Leakage Report