joinspy/_pkgdown.yml at main · gcol33/joinspy · 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
url: https://gillescolling.com/joinspy/
template:
  bootstrap: 5
  bootswatch: sandstone
  light-switch: yes
  includes:
    in_header: |
      <script>
      (function () {
        var D = String.fromCharCode(36);
        window.MathJax = {
          tex: {
            inlineMath: [[D, D], ["\\(", "\\)"]],
            displayMath: [[D + D, D + D], ["\\[", "\\]"]]
          },
          chtml: { linebreaks: { automatic: true, width: "90% container" } },
          svg: { linebreaks: { automatic: true, width: "90% container" } },
          options: { renderActions: { addMenu: [] } }
        };
      })();
      </script>
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: Why Your Keys Don't Match
        href: articles/why-keys-dont-match.html
      - text: Common Join Problems
        href: articles/common-issues.html
      - text: Joins in Production
        href: articles/production.html
      - text: Working with Backends
        href: articles/backends.html
    github:
      icon: fab fa-github
      href: https://github.com/gcol33/joinspy
      aria-label: GitHub
reference:
- title: Pre-Join Diagnostics
  desc: Analyze tables before joining
  contents:
  - join_spy
  - key_check
  - key_duplicates
- title: Post-Join Diagnostics
  desc: Understand what happened after a join
  contents:
  - join_explain
  - join_diff
- title: Safe Join Wrappers
  desc: Joins with built-in diagnostics
  contents:
  - join_strict
  - left_join_spy
  - right_join_spy
  - inner_join_spy
  - full_join_spy
  - last_report
- title: Auto-Repair
  desc: Fix common key issues automatically
  contents:
  - join_repair
  - suggest_repairs
- title: Advanced Analysis
  desc: Cardinality detection and multi-table chains
  contents:
  - detect_cardinality
  - check_cartesian
  - analyze_join_chain
- title: S3 Methods
  desc: Methods for JoinReport objects (print, plot, summary)
  contents:
  - print.JoinReport
  - summary.JoinReport
  - plot.JoinReport
- title: Logging & Audit
  desc: Log reports for reproducibility
  contents:
  - log_report
  - set_log_file
  - get_log_file
- title: Helpers
  contents: is_join_report
articles:
- title: Getting Started
  navbar: ~
  contents: quickstart
- title: Key Diagnostics
  navbar: ~
  contents:
  - why-keys-dont-match
  - common-issues
- title: Usage Guides
  navbar: ~
  contents:
  - production
  - backends