ggRandomForests/_pkgdown.yml at main · ehrlinger/ggRandomForests · 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
url: https://ehrlinger.github.io/ggRandomForests

template:
  bootstrap: 5
  bslib:
    bootswatch: zephyr
    base_font: {google: "Outfit"}
    code_font: {google: "Fira Code"}
  light-switch: true
  theme: atom-one-light
  theme-dark: atom-one-dark

home:
  sidebar:
    structure: [badges, links, authors, dev]
    components:
      badges:
        title: Package status
        text: |
          [![CRAN](https://www.r-pkg.org/badges/version/ggRandomForests)](https://cran.r-project.org/package=ggRandomForests)
          [![Dev version](https://img.shields.io/github/r-package/v/ehrlinger/ggRandomForests)](https://github.com/ehrlinger/ggRandomForests)
          [![R-CMD-check](https://github.com/ehrlinger/ggRandomForests/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ehrlinger/ggRandomForests/actions/workflows/R-CMD-check.yaml)
          [![Codecov](https://codecov.io/gh/ehrlinger/ggRandomForests/graph/badge.svg)](https://app.codecov.io/gh/ehrlinger/ggRandomForests)
          [![CRAN downloads](https://cranlogs.r-pkg.org/badges/ggRandomForests)](https://cranlogs.r-pkg.org/badges/ggRandomForests)
          [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11526.svg)](https://doi.org/10.5281/zenodo.11526)

navbar:
  structure:
    left:  [intro, reference, articles, news]
    right: [search, github, my_linkedin, lightswitch]
  components:
    my_linkedin:
      icon: fa-linkedin
      href: https://www.linkedin.com/in/ehrlinger/
      aria-label: LinkedIn
    articles:
      text: Articles
      menu:
        - text: "Get Started"
          href: articles/ggRandomForests.html
        - text: "---"
        - text: "Tutorials"
        - text: "Random Forest Survival Analysis"
          href: articles/ggRandomForests-survival.html
        - text: "Random Forest Regression"
          href: articles/ggRandomForests-regression.html

reference:
  - title: "Forest Objects"
    desc: "Extract and display data from random forest objects."
    contents:
      - gg_rfsrc.rfsrc
      - plot.gg_rfsrc

  - title: "Training Error"
    desc: "Visualize forest convergence and training error."
    contents:
      - gg_error
      - plot.gg_error

  - title: "Variable Importance"
    desc: "Assess and plot variable importance (VIMP)."
    contents:
      - gg_vimp
      - plot.gg_vimp

  - title: "Variable Dependence"
    desc: "Marginal variable dependence plots."
    contents:
      - gg_variable
      - plot.gg_variable

  - title: "Partial Dependence"
    desc: "Partial dependence plots for individual variables."
    contents:
      - gg_partial
      - plot.gg_partial
      - gg_partial_rfsrc
      - plot.gg_partial_rfsrc
      - gg_partialpro
      - plot.gg_partialpro

  - title: "Survival Analysis"
    desc: "Survival curves, ROC, and related diagnostics."
    contents:
      - gg_survival
      - plot.gg_survival
      - gg_roc.rfsrc
      - plot.gg_roc
      - calc_roc.rfsrc
      - calc_auc
      - surv_partial.rfsrc
      - kaplan
      - nelson

  - title: "Utilities"
    desc: "Helper functions used internally and by users."
    contents:
      - quantile_pts
      - varpro_feature_names

  - title: "Package"
    contents:
      - ggRandomForests-package

articles:
  - title: "Get started"
    navbar: ~
    contents:
      - ggRandomForests
  - title: "Tutorials"
    contents:
      - ggRandomForests-survival
      - ggRandomForests-regression

news:
  releases:
  - text: "Version 2.6"
    href: https://github.com/ehrlinger/ggRandomForests/blob/main/NEWS.md

footer:
  structure:
    left: developed_by
    right: built_with_pkgdown
  components:
    developed_by: "John Ehrlinger"
    built_with_pkgdown: "Built with [pkgdown](https://pkgdown.r-lib.org/)"