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

template:
  package: nesttemplate

navbar:
  structure:
    left: [intro, reference, articles, tutorials, news, reports]
    right: [search, github]
  components:
    reports:
      text: Reports
      menu:
        - text: Coverage report
          href: coverage-report/
        - text: Unit test report
          href: unit-test-report/
        - text: Non-CRAN unit test report
          href: unit-test-report-non-cran/
    github:
      icon: fa-github
      href: https://github.com/insightsengineering/teal.reporter
      aria-label: View on Github

reference:
  - title: "`shiny` modules for adding content to reports"
    contents:
      - add_card_button_srv
      - add_card_button_ui
  - title: "`shiny` modules for viewing and downloading reports"
    contents:
      - simple_reporter_srv
      - simple_reporter_ui
  - title: Supporting `shiny` modules
    contents:
      - download_report_button_srv
      - download_report_button_ui
      - reset_report_button_srv
      - reset_report_button_ui
      - report_load_srv
      - report_load_ui
      - srv_editor_block
      - ui_editor_block
      - add_card_button
      - download_report_button
      - reset_report_button
      - load_report_button
      - reporter_previewer
  - title: "`yaml` and rmd utility functions"
    contents:
      - to_rmd
      - as_yaml_auto
      - print.rmd_yaml_header
      - rmd_output_arguments
      - rmd_outputs
  - title: "Classes used inside package"
    contents:
      - teal_card
      - teal_report
      - ReportCard
      - Reporter
  - title: "Utility functions for `teal_card` object"
    contents:
      - as.teal_card
      - code_chunk
      - metadata
      - "metadata<-"
      - render
      - teal_card
      - "teal_card<-"
      - teal_card-preview
  - title: "Utility functions for `teal_report` object"
    contents:
      - c.teal_report
      - eval_code,teal_report-method
  - title: "Deprecated functions"
    contents:
      - reporter_previewer_deprecated