BORG/_pkgdown.yml at main · gcol33/BORG · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
url: https://gillescolling.com/BORG
template:
  bootstrap: 5
  bootswatch: sandstone
  light-switch: yes
  includes:
    in_header: pkgdown/mathjax-config.html
figures:
  dev: svg
  fig.ext: svg
  bg: '#F5F6F8'
home:
  title: 'BORG: Bounded Outcome Risk Guard for Model Evaluation'
  description: |
    Automatically detects and enforces valid model evaluation by identifying information reuse between training and evaluation data.
authors:
  Gilles Colling:
    href: https://github.com/gcol33
navbar:
  structure:
    left:
    - intro
    - reference
    - articles
    - news
    right:
    - search
    - lightswitch
    - github
  components:
    intro:
      text: Get Started
      href: articles/quickstart.html
    articles:
      text: Articles
      menu:
      - text: Quick Start
        href: articles/quickstart.html
      - text: Risk Taxonomy
        href: articles/risk-taxonomy.html
      - text: Framework Integration
        href: articles/frameworks.html
    github:
      icon: fab fa-github
      href: https://github.com/gcol33/BORG
      aria-label: GitHub
reference:
- title: Main Entry Point
  desc: Start here
  contents:
  - borg
  - borg_workflow
- title: Core Functions
  desc: Detailed validation functions
  contents:
  - borg_inspect
  - borg_validate
  - borg_certificate
  - borg_export
- title: Remediation
  desc: Automatic pipeline correction
  contents: borg_assimilate
- title: Spatial Tools
  desc: Raster extraction, thinning, blocking, and geographic analysis
  contents:
  - borg_extract
  - borg_thin
  - borg_block_size
  - borg_check_coverage
  - borg_leaflet
  - borg_prediction_map
  - borg_importance
- title: Visualization
  desc: Plot and summary methods for BORG objects
  contents:
  - plot.BorgRisk
  - plot.borg_result
  - plot.borg_comparison
  - autoplot.borg_fold_perf
  - summary.BorgRisk
  - summary.BorgDiagnosis
  - summary.borg_result
- title: Diagnosis & Evidence
  desc: Dependency detection, CV comparison, and power analysis
  contents:
  - borg_diagnose
  - borg_compare_cv
  - borg_power
  - borg_cv
  - borg_fold_performance
  - borg_stability
  - borg_check_nested_cv
  - BorgDiagnosis
- title: Reporting
  desc: HTML reports and certificates
  contents:
  - borg_report
  - borg_certificate
  - borg_export
- title: Audit Functions
  desc: Prediction and CV auditing
  contents:
  - audit_predictions
  - audit_importance
  - cv_leakage_report
- title: SDM Integration
  desc: Species distribution modelling frameworks
  contents:
  - borg_to_enmeval
  - borg_to_biomod2
- title: Framework Integration
  desc: Wrappers for ML frameworks (tidymodels, caret, mlr3)
  contents:
  - borg_spatial_cv
  - borg_temporal_cv
  - borg-wrappers
  - borg_initial_split
  - borg_vfold_cv
  - borg_group_vfold_cv
  - borg_trainControl
  - borg_register_hooks
  - borg_unregister_hooks
- title: Configuration
  desc: Options and settings
  contents:
  - borg_auto_check
  - borg_options
- title: Classes
  desc: Result objects
  contents:
  - BorgRisk-class
  - as.data.frame.BorgRisk
  - print.borg_cv_report
articles:
- title: Getting Started
  navbar: ~
  contents: quickstart
- title: Deep Dives
  navbar: ~
  contents:
  - risk-taxonomy
  - frameworks
footer:
  structure:
    left: developed_by
    right: built_with