causalDisco/_pkgdown.yml at main · disco-coders/causalDisco · 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
url: https://disco-coders.github.io/causalDisco/
template:
  bootstrap: 5
  math-rendering: katex

reference:

  - title: "Overview"
    desc: >
      Package overview
    contents:
      - causalDisco-package

  - title: "Causal Discovery Interface"
    desc: "High-level interface for running causal discovery."
    contents:
      - disco
      - knowledge

  - title: "Causal Discovery Algorithms"
    desc: "Core search algorithms implemented or wrapped by causalDisco."
    contents:
      - has_concept("cd_algorithms")

  - title: "R6 Classes"
    contents:
      - ends_with("Search")

  - title: "Setup for Tetrad Engine"
    desc: "Functions for installing and verifying the Tetrad Java backend."
    contents:
      - install_tetrad
      - verify_tetrad

  - title: "causalDisco Algorithm Run Functions"
    desc: "Low-level functions that execute causalDisco search algorithms and detail their parameters."
    contents:
      - ends_with("run")

  - title: "Tests for TPC"
    desc: "Test functions implemented for use in the TPC algorithm."
    contents:
      - cor_test
      - reg_test

  - title: "Simulation"
    contents:
      - starts_with("generate")
      - starts_with("sim")

  - title: "Example Datasets"
    desc: "Small simulated datasets to illustrate causalDisco workflows."
    contents:
      - has_concept("dataset")

  - title: "Printing, Summarizing, and Plotting Objects"
    contents:
      - has_concept("print")
      - starts_with("summary")
      - has_concept("plot")
      - make_tikz

  - title: "Graph Metrics"
    contents:
      - has_concept("metrics")
      - reexports

  - title: "Knowledge helpers"
    contents:
      - has_concept("knowledge-helper")

  - title: "Extend causalDisco"
    desc: "Functions for extending causalDisco with new algorithms from the available engines."
    contents:
      - has_concept("extending_causalDisco")