From 1765f4653eec45818e1856b93f2a24f092e0ea99 Mon Sep 17 00:00:00 2001 From: m7pr Date: Tue, 23 Jan 2024 15:35:29 +0000 Subject: [PATCH] [actions skip] Built site for teal.reporter@57a8db2928388c2de979860f824f737368133c78 --- main/404.html | 13 +++++++++++++ main/CODE_OF_CONDUCT.html | 13 +++++++++++++ main/CONTRIBUTING.html | 13 +++++++++++++ main/LICENSE-text.html | 13 +++++++++++++ main/SECURITY.html | 13 +++++++++++++ main/articles/index.html | 13 +++++++++++++ main/articles/previewerReporter.html | 13 +++++++++++++ main/articles/simpleReporter.html | 13 +++++++++++++ main/articles/teal-reporter.html | 13 +++++++++++++ main/authors.html | 13 +++++++++++++ main/index.html | 13 +++++++++++++ main/news/index.html | 13 +++++++++++++ main/pull_request_template.html | 13 +++++++++++++ main/reference/Archiver.html | 13 +++++++++++++ main/reference/ContentBlock.html | 13 +++++++++++++ main/reference/FileArchiver.html | 13 +++++++++++++ main/reference/FileBlock.html | 13 +++++++++++++ main/reference/JSONArchiver.html | 13 +++++++++++++ main/reference/NewpageBlock.html | 13 +++++++++++++ main/reference/RcodeBlock.html | 13 +++++++++++++ main/reference/Renderer.html | 13 +++++++++++++ main/reference/ReportCard.html | 13 +++++++++++++ main/reference/Reporter.html | 13 +++++++++++++ main/reference/TableBlock.html | 13 +++++++++++++ main/reference/TextBlock.html | 13 +++++++++++++ main/reference/add_card_button_srv.html | 13 +++++++++++++ main/reference/add_card_button_ui.html | 13 +++++++++++++ main/reference/as_yaml_auto.html | 13 +++++++++++++ main/reference/conv_str_logi.html | 13 +++++++++++++ main/reference/download_report_button_srv.html | 13 +++++++++++++ main/reference/download_report_button_ui.html | 13 +++++++++++++ main/reference/get_bs_version.html | 13 +++++++++++++ main/reference/get_yaml_field.html | 13 +++++++++++++ main/reference/index.html | 13 +++++++++++++ main/reference/md_header.html | 13 +++++++++++++ main/reference/panel_item.html | 13 +++++++++++++ main/reference/print.rmd_yaml_header.html | 13 +++++++++++++ main/reference/report_render_and_compress.html | 13 +++++++++++++ main/reference/reporter_download_inputs.html | 13 +++++++++++++ main/reference/reporter_previewer_srv.html | 13 +++++++++++++ main/reference/reporter_previewer_ui.html | 13 +++++++++++++ main/reference/reset_report_button_srv.html | 13 +++++++++++++ main/reference/reset_report_button_ui.html | 13 +++++++++++++ main/reference/rmd_output_arguments.html | 13 +++++++++++++ main/reference/rmd_outputs.html | 13 +++++++++++++ main/reference/simple_reporter_srv.html | 13 +++++++++++++ main/reference/simple_reporter_ui.html | 13 +++++++++++++ main/reference/split_text_block.html | 13 +++++++++++++ main/reference/teal.reporter.html | 13 +++++++++++++ main/reference/to_flextable.html | 13 +++++++++++++ main/reference/yaml_quoted.html | 13 +++++++++++++ main/search.json | 2 +- 52 files changed, 664 insertions(+), 1 deletion(-) diff --git a/main/404.html b/main/404.html index b41da629..aef7cb32 100644 --- a/main/404.html +++ b/main/404.html @@ -50,6 +50,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/CODE_OF_CONDUCT.html b/main/CODE_OF_CONDUCT.html index 53123290..06a801f2 100644 --- a/main/CODE_OF_CONDUCT.html +++ b/main/CODE_OF_CONDUCT.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/CONTRIBUTING.html b/main/CONTRIBUTING.html index 7d3bc298..7b1d7cb3 100644 --- a/main/CONTRIBUTING.html +++ b/main/CONTRIBUTING.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/LICENSE-text.html b/main/LICENSE-text.html index 861d5c33..fc2a3f5e 100644 --- a/main/LICENSE-text.html +++ b/main/LICENSE-text.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/SECURITY.html b/main/SECURITY.html index df468a9f..618e4fa8 100644 --- a/main/SECURITY.html +++ b/main/SECURITY.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/articles/index.html b/main/articles/index.html index fe7befd7..3dab3dae 100644 --- a/main/articles/index.html +++ b/main/articles/index.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/articles/previewerReporter.html b/main/articles/previewerReporter.html index e6499bf3..437c5530 100644 --- a/main/articles/previewerReporter.html +++ b/main/articles/previewerReporter.html @@ -52,6 +52,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/articles/simpleReporter.html b/main/articles/simpleReporter.html index ac96520e..2dc9fed1 100644 --- a/main/articles/simpleReporter.html +++ b/main/articles/simpleReporter.html @@ -52,6 +52,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/articles/teal-reporter.html b/main/articles/teal-reporter.html index a8d3718c..dc74171a 100644 --- a/main/articles/teal-reporter.html +++ b/main/articles/teal-reporter.html @@ -52,6 +52,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/authors.html b/main/authors.html index d668e027..8d6e22a3 100644 --- a/main/authors.html +++ b/main/authors.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/index.html b/main/index.html index 27b59aae..fd839c26 100644 --- a/main/index.html +++ b/main/index.html @@ -54,6 +54,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/news/index.html b/main/news/index.html index 33f4156a..d43d58ae 100644 --- a/main/news/index.html +++ b/main/news/index.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/pull_request_template.html b/main/pull_request_template.html index a7f6f2ea..980bcb70 100644 --- a/main/pull_request_template.html +++ b/main/pull_request_template.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/Archiver.html b/main/reference/Archiver.html index 74f46f88..4f6218da 100644 --- a/main/reference/Archiver.html +++ b/main/reference/Archiver.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/ContentBlock.html b/main/reference/ContentBlock.html index d3d734f1..c9a486ec 100644 --- a/main/reference/ContentBlock.html +++ b/main/reference/ContentBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/FileArchiver.html b/main/reference/FileArchiver.html index 1b82db8a..efa19993 100644 --- a/main/reference/FileArchiver.html +++ b/main/reference/FileArchiver.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/FileBlock.html b/main/reference/FileBlock.html index cbc3723e..207c4683 100644 --- a/main/reference/FileBlock.html +++ b/main/reference/FileBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/JSONArchiver.html b/main/reference/JSONArchiver.html index 08f7acb1..71704dee 100644 --- a/main/reference/JSONArchiver.html +++ b/main/reference/JSONArchiver.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/NewpageBlock.html b/main/reference/NewpageBlock.html index 2f944f3b..cb16ad2d 100644 --- a/main/reference/NewpageBlock.html +++ b/main/reference/NewpageBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/RcodeBlock.html b/main/reference/RcodeBlock.html index 67585c7c..2a86e5eb 100644 --- a/main/reference/RcodeBlock.html +++ b/main/reference/RcodeBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/Renderer.html b/main/reference/Renderer.html index 35ef0562..5e800bef 100644 --- a/main/reference/Renderer.html +++ b/main/reference/Renderer.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/ReportCard.html b/main/reference/ReportCard.html index 0141ac54..141f000e 100644 --- a/main/reference/ReportCard.html +++ b/main/reference/ReportCard.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/Reporter.html b/main/reference/Reporter.html index 04382ee7..06beb4c6 100644 --- a/main/reference/Reporter.html +++ b/main/reference/Reporter.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/TableBlock.html b/main/reference/TableBlock.html index 53366dad..8d2c8ad5 100644 --- a/main/reference/TableBlock.html +++ b/main/reference/TableBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/TextBlock.html b/main/reference/TextBlock.html index b9fbc299..cc3d103d 100644 --- a/main/reference/TextBlock.html +++ b/main/reference/TextBlock.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/add_card_button_srv.html b/main/reference/add_card_button_srv.html index 5b78ebd6..001f56c1 100644 --- a/main/reference/add_card_button_srv.html +++ b/main/reference/add_card_button_srv.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/add_card_button_ui.html b/main/reference/add_card_button_ui.html index 9ceab282..3ebd9f9a 100644 --- a/main/reference/add_card_button_ui.html +++ b/main/reference/add_card_button_ui.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/as_yaml_auto.html b/main/reference/as_yaml_auto.html index 7257b7ed..2121abb1 100644 --- a/main/reference/as_yaml_auto.html +++ b/main/reference/as_yaml_auto.html @@ -46,6 +46,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/conv_str_logi.html b/main/reference/conv_str_logi.html index eff28e9b..d48c3324 100644 --- a/main/reference/conv_str_logi.html +++ b/main/reference/conv_str_logi.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/download_report_button_srv.html b/main/reference/download_report_button_srv.html index e9eca5fa..8ebb828f 100644 --- a/main/reference/download_report_button_srv.html +++ b/main/reference/download_report_button_srv.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/download_report_button_ui.html b/main/reference/download_report_button_ui.html index 24382efb..0f99ecb7 100644 --- a/main/reference/download_report_button_ui.html +++ b/main/reference/download_report_button_ui.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/get_bs_version.html b/main/reference/get_bs_version.html index 57a88e48..a8f42b77 100644 --- a/main/reference/get_bs_version.html +++ b/main/reference/get_bs_version.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/get_yaml_field.html b/main/reference/get_yaml_field.html index 0a29fce9..4c85ecf1 100644 --- a/main/reference/get_yaml_field.html +++ b/main/reference/get_yaml_field.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/index.html b/main/reference/index.html index f0ca9111..7cc9ffb1 100644 --- a/main/reference/index.html +++ b/main/reference/index.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/md_header.html b/main/reference/md_header.html index 719c069b..ddd11a75 100644 --- a/main/reference/md_header.html +++ b/main/reference/md_header.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/panel_item.html b/main/reference/panel_item.html index 5940f286..06eedd6f 100644 --- a/main/reference/panel_item.html +++ b/main/reference/panel_item.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/print.rmd_yaml_header.html b/main/reference/print.rmd_yaml_header.html index d2da7365..65a79d6c 100644 --- a/main/reference/print.rmd_yaml_header.html +++ b/main/reference/print.rmd_yaml_header.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/report_render_and_compress.html b/main/reference/report_render_and_compress.html index 79b9c184..5c925d53 100644 --- a/main/reference/report_render_and_compress.html +++ b/main/reference/report_render_and_compress.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/reporter_download_inputs.html b/main/reference/reporter_download_inputs.html index 6fca3b99..84cd70f4 100644 --- a/main/reference/reporter_download_inputs.html +++ b/main/reference/reporter_download_inputs.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/reporter_previewer_srv.html b/main/reference/reporter_previewer_srv.html index 41452786..2df14229 100644 --- a/main/reference/reporter_previewer_srv.html +++ b/main/reference/reporter_previewer_srv.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/reporter_previewer_ui.html b/main/reference/reporter_previewer_ui.html index efa62311..48f615ac 100644 --- a/main/reference/reporter_previewer_ui.html +++ b/main/reference/reporter_previewer_ui.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/reset_report_button_srv.html b/main/reference/reset_report_button_srv.html index 00b0bde8..d9d7b1e3 100644 --- a/main/reference/reset_report_button_srv.html +++ b/main/reference/reset_report_button_srv.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/reset_report_button_ui.html b/main/reference/reset_report_button_ui.html index f4c2256b..e8e7905a 100644 --- a/main/reference/reset_report_button_ui.html +++ b/main/reference/reset_report_button_ui.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/rmd_output_arguments.html b/main/reference/rmd_output_arguments.html index d3015daa..98690086 100644 --- a/main/reference/rmd_output_arguments.html +++ b/main/reference/rmd_output_arguments.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/rmd_outputs.html b/main/reference/rmd_outputs.html index ab42906e..1c48d07e 100644 --- a/main/reference/rmd_outputs.html +++ b/main/reference/rmd_outputs.html @@ -36,6 +36,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/simple_reporter_srv.html b/main/reference/simple_reporter_srv.html index 62cb07d6..ab5cc82d 100644 --- a/main/reference/simple_reporter_srv.html +++ b/main/reference/simple_reporter_srv.html @@ -42,6 +42,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/simple_reporter_ui.html b/main/reference/simple_reporter_ui.html index f43aa751..afbcf0c5 100644 --- a/main/reference/simple_reporter_ui.html +++ b/main/reference/simple_reporter_ui.html @@ -38,6 +38,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/split_text_block.html b/main/reference/split_text_block.html index 2a3686bd..2bf55ee1 100644 --- a/main/reference/split_text_block.html +++ b/main/reference/split_text_block.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/teal.reporter.html b/main/reference/teal.reporter.html index 0996d636..52ca604f 100644 --- a/main/reference/teal.reporter.html +++ b/main/reference/teal.reporter.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/to_flextable.html b/main/reference/to_flextable.html index 89a4f9e8..3bc96d31 100644 --- a/main/reference/to_flextable.html +++ b/main/reference/to_flextable.html @@ -42,6 +42,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/reference/yaml_quoted.html b/main/reference/yaml_quoted.html index 9d838ca6..6b6785e0 100644 --- a/main/reference/yaml_quoted.html +++ b/main/reference/yaml_quoted.html @@ -34,6 +34,19 @@
  • Changelog
    • +
  • +
    main +latest-tag +release-candidate +v0.2.1-rc2 +v0.2.1-rc1 +v0.2.1 +v0.2.0 +v0.1.1
    • +
  • diff --git a/main/search.json b/main/search.json index a66b18a8..4e542aba 100644 --- a/main/search.json +++ b/main/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contribution Guidelines","title":"Contribution Guidelines","text":"🙏 Thank taking time contribute! input deeply valued, whether issue, pull request, even feedback, regardless size, content scope.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contribution Guidelines","text":"👶 Getting started 📔 Code Conduct 🗃 License 📜 Issues 🚩 Pull requests 💻 Coding guidelines 🏆 Recognition model ❓ Questions","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Contribution Guidelines","text":"Please refer project documentation brief introduction. Please also see articles within project documentation additional information.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contribution Guidelines","text":"Code Conduct governs project. Participants contributors expected follow rules outlined therein.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Contribution Guidelines","text":"contributions covered project’s license.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"issues","dir":"","previous_headings":"","what":"Issues","title":"Contribution Guidelines","text":"use GitHub track issues, feature requests, bugs. submitting new issue, please check issue already reported. issue already exists, please upvote existing issue 👍. new feature requests, please elaborate context benefit feature users, developers, relevant personas.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"github-flow","dir":"","previous_headings":"Pull requests","what":"GitHub Flow","title":"Contribution Guidelines","text":"repository uses GitHub Flow model collaboration. submit pull request: Create branch Please see branch naming convention . don’t write access repository, please fork . Make changes Make sure code passes checks imposed GitHub Actions well documented well tested unit tests sufficiently covering changes introduced Create pull request (PR) pull request description, please link relevant issue (), provide detailed description change, include assumptions. Address review comments, Post approval Merge PR write access. Otherwise, reviewer merge PR behalf. Pat back Congratulations! 🎉 now official contributor project! grateful contribution.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"branch-naming-convention","dir":"","previous_headings":"Pull requests","what":"Branch naming convention","title":"Contribution Guidelines","text":"Suppose changes related current issue current project; please name branch follows: _. Please use underscore (_) delimiter word separation. example, 420_fix_ui_bug suitable branch name change resolving UI-related bug reported issue number 420 current project. change affects multiple repositories, please name branches follows: __. example, 69_awesomeproject_fix_spelling_error reference issue 69 reported project awesomeproject aims resolve one spelling errors multiple (likely related) repositories.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"monorepo-and-stageddependencies","dir":"","previous_headings":"Pull requests","what":"monorepo and staged.dependencies","title":"Contribution Guidelines","text":"Sometimes might need change upstream dependent package(s) able submit meaningful change. using staged.dependencies functionality simulate monorepo behavior. dependency configuration already specified project’s staged_dependencies.yaml file. need name feature branches appropriately. exception branch naming convention described . Please refer staged.dependencies package documentation details.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"coding-guidelines","dir":"","previous_headings":"","what":"Coding guidelines","title":"Contribution Guidelines","text":"repository follows unified processes standards adopted maintainers ensure software development carried consistently within teams cohesively across repositories.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"Coding guidelines","what":"Style guide","title":"Contribution Guidelines","text":"repository follows standard tidyverse style guide uses lintr lint checks. Customized lint configurations available repository’s .lintr file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"dependency-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency management","title":"Contribution Guidelines","text":"Lightweight right weight. repository follows tinyverse recommedations limiting dependencies minimum.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"dependency-version-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency version management","title":"Contribution Guidelines","text":"code compatible (!) historical versions given dependenct package, required specify minimal version DESCRIPTION file. particular: development version requires (imports) development version another package - required put abc (>= 1.2.3.9000).","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"r--package-versions","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"R & package versions","title":"Contribution Guidelines","text":"continuously test packages newest R version along recent dependencies CRAN BioConductor. recommend working environment also set way. can find details R version packages used R CMD check GitHub Action execution log - step prints R sessionInfo(). discover bugs older R versions older set dependencies, please create relevant bug reports.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"pre-commit","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"pre-commit","title":"Contribution Guidelines","text":"highly recommend use pre-commit tool combined R hooks pre-commit execute checks committing pushing changes. Pre-commit hooks already available repository’s .pre-commit-config.yaml file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"recognition-model","dir":"","previous_headings":"","what":"Recognition model","title":"Contribution Guidelines","text":"mentioned previously, contributions deeply valued appreciated. contribution data available part repository insights, recognize significant contribution hence add contributor package authors list, following rules enforced: Minimum 5% lines code authored* (determined git blame query) top 5 contributors terms number commits lines added lines removed* *Excluding auto-generated code, including limited roxygen comments renv.lock files. package maintainer also reserves right adjust criteria recognize contributions.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/CONTRIBUTING.html","id":"questions","dir":"","previous_headings":"","what":"Questions","title":"Contribution Guidelines","text":"questions regarding contribution guidelines, please contact package/repository maintainer.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/SECURITY.html","id":"reporting-security-issues","dir":"","previous_headings":"","what":"Reporting Security Issues","title":"Security Policy","text":"believe found security vulnerability repositories organization, please report us coordinated disclosure. Please report security vulnerabilities public GitHub issues, discussions, pull requests. Instead, please send email vulnerability.management[@]roche.com. Please include much information listed can help us better understand resolve issue: type issue (e.g., buffer overflow, SQL injection, cross-site scripting) Full paths source file(s) related manifestation issue location affected source code (tag/branch/commit direct URL) special configuration required reproduce issue Step--step instructions reproduce issue Proof--concept exploit code (possible) Impact issue, including attacker might exploit issue information help us triage report quickly.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/SECURITY.html","id":"data-security-standards-dss","dir":"","previous_headings":"","what":"Data Security Standards (DSS)","title":"Security Policy","text":"Please make sure reporting issues form bug, feature, pull request, sensitive information PII, PHI, PCI completely removed text attachments, including pictures videos.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/articles/teal-reporter.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Getting Started with teal.reporter","text":"times explore data shiny module, spot interesting finding capture , slides presentation, markdown article another medium. teal.reporter helps enhance shiny module users copy-paste save every finding write markdown show . teal.reporter gives ready use shiny modules objects work together prepare reports module minimal input users shiny modules developer. can done easy adding one reporting tools module:","code":"library(teal.reporter) ## ui <- shiny::fluidPage(simple_reporter_ui(\"simple\")) server <- function(input, output, session) { # The bulk of your module logic here create_module_card <- function(card) { card$append_text(\"This is the content of the report from the `simple` module\") } simple_reporter_srv(\"simple\", Reporter$new(), create_module_card) } if (interactive()) shiny::shinyApp(ui, server)"},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/articles/teal-reporter.html","id":"basic-usage","dir":"Articles","previous_headings":"Where to next","what":"Basic usage","title":"Getting Started with teal.reporter","text":"basic usage teal.reporter quickest way enhance modules reporting, head vignette simple reporting setup.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/articles/teal-reporter.html","id":"previewing-a-report","dir":"Articles","previous_headings":"Where to next","what":"Previewing a report","title":"Getting Started with teal.reporter","text":"want let users application preview report reorganize , look vignette “report previewer” module.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/articles/teal-reporter.html","id":"integration-with-teal","dir":"Articles","previous_headings":"Where to next","what":"Integration with teal","title":"Getting Started with teal.reporter","text":"interested teal.reporter fits teal, look vignette teal.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/articles/teal-reporter.html","id":"more-control","dir":"Articles","previous_headings":"Where to next","what":"More control","title":"Getting Started with teal.reporter","text":"like control layout simple reporting tool, recommend reading documentation smallest building blocks teal.reporter offers, add_card_button_srv(), download_report_button_srv() reset_report_button_srv().","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Dawid Kaledkowski. Maintainer. Maciej Nasinski. Author. Konrad Pagacz. Author. Mahmoud mahmoud.hallal@roche.com Hallal. Author. F. Hoffmann-La Roche AG. Copyright holder, funder.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Nasinski M, Pagacz K, Hallal Mm (2024). teal.reporter: Reporting Tools 'shiny' Modules. R package version 0.2.1.9015, https://insightsengineering.github.io/teal.reporter/, https://github.com/insightsengineering/teal.reporter.","code":"@Manual{, title = {teal.reporter: Reporting Tools for 'shiny' Modules}, author = {Maciej Nasinski and Konrad Pagacz and Mahmoud mahmoud.hallal@roche.com Hallal}, year = {2024}, note = {R package version 0.2.1.9015, https://insightsengineering.github.io/teal.reporter/}, url = {https://github.com/insightsengineering/teal.reporter}, }"},{"path":"https://insightsengineering.github.io/teal.reporter/index.html","id":"tealreporter","dir":"","previous_headings":"","what":"Reporting Tools for shiny Modules","title":"Reporting Tools for shiny Modules","text":"teal.reporter empowers shiny teal applications seamlessly integrate reporting functionality. Developers, whether working shiny app teal module, define report’s content, teal.reporter takes care rest. package provides: shiny module adding cards (.e. items) report shiny module previewing report -screen ability download zip file containing reports","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Reporting Tools for shiny Modules","text":"Alternatively, might want use development version available r-universe.","code":"# stable versions install.packages('teal.reporter') # install.packages(\"pak\") pak::pak(\"insightsengineering/teal.reporter@*release\") # beta versions install.packages('teal.reporter', repos = c('https://pharmaverse.r-universe.dev', getOption('repos'))) # install.packages(\"pak\") pak::pak(\"insightsengineering/teal.reporter\")"},{"path":"https://insightsengineering.github.io/teal.reporter/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Reporting Tools for shiny Modules","text":"understand use package, please refer Getting Started article, provides multiple examples code implementation.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/index.html","id":"getting-help","dir":"","previous_headings":"","what":"Getting help","title":"Reporting Tools for shiny Modules","text":"encounter bug feature request - please file issue. questions, discussions staying date, please use “teal” channel pharmaverse slack workspace.","code":""},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/pull_request_template.html","id":null,"dir":"","previous_headings":"","what":"Pull Request","title":"Pull Request","text":"Fixes #nnn","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":null,"dir":"Reference","previous_headings":"","what":"Archiver — Archiver","title":"Archiver — Archiver","text":"Archiver Archiver","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Archiver — Archiver","text":"Archiver$new() Archiver$finalize() Archiver$read() Archiver$write() Archiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Archiver — Archiver","text":"Returns Archiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Archiver — Archiver","text":"Archiver object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Archiver — Archiver","text":"","code":"Archiver <- getFromNamespace(\"Archiver\", \"teal.reporter\") Archiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"Archiver — Archiver","text":"Finalizes Archiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"method-read-","dir":"Reference","previous_headings":"","what":"Method read()","title":"Archiver — Archiver","text":"Pure virtual method reading Archiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$read()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"method-write-","dir":"Reference","previous_headings":"","what":"Method write()","title":"Archiver — Archiver","text":"Pure virtual method writing Archiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$write()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Archiver — Archiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Archiver — Archiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Archiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Archiver — Archiver","text":"","code":"## ------------------------------------------------ ## Method `Archiver$new` ## ------------------------------------------------ Archiver <- getFromNamespace(\"Archiver\", \"teal.reporter\") Archiver$new() #> #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> initialize: function () #> read: function () #> write: function ()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"ContentBlock — ContentBlock","title":"ContentBlock — ContentBlock","text":"ContentBlock ContentBlock","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ContentBlock — ContentBlock","text":"ContentBlock$new() ContentBlock$set_content() ContentBlock$get_content() ContentBlock$from_list() ContentBlock$to_list() ContentBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ContentBlock — ContentBlock","text":"Returns ContentBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"ContentBlock — ContentBlock","text":"Returns ContentBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") ContentBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-set-content-","dir":"Reference","previous_headings":"","what":"Method set_content()","title":"ContentBlock — ContentBlock","text":"Sets content ContentBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$set_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"content (character(0) character(1)) string literal file path assigned ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$set_content(\"Base64 encoded picture\")"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"ContentBlock — ContentBlock","text":"Returns absolute path content ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"character content ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"ContentBlock — ContentBlock","text":"Create ContentBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"x named list two fields c(\"text\", \"style\"). Use get_available_styles method get possible styles.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"ContentBlock — ContentBlock","text":"Convert ContentBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"named list text style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ContentBlock — ContentBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ContentBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"## ------------------------------------------------ ## Method `ContentBlock$new` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") ContentBlock$new() #> #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_content: function () #> initialize: function () #> set_content: function (content) #> to_list: function () #> Private: #> content: #> deep_clone: function (name, value) ## ------------------------------------------------ ## Method `ContentBlock$set_content` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$set_content(\"Base64 encoded picture\") ## ------------------------------------------------ ## Method `ContentBlock$get_content` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$get_content() #> character(0)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":null,"dir":"Reference","previous_headings":"","what":"RDSArchiver — FileArchiver","title":"RDSArchiver — FileArchiver","text":"RDSArchiver RDSArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"RDSArchiver — FileArchiver","text":"teal.reporter::Archiver -> FileArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"RDSArchiver — FileArchiver","text":"teal.reporter::Archiver$read() teal.reporter::Archiver$write()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"RDSArchiver — FileArchiver","text":"FileArchiver$new() FileArchiver$finalize() FileArchiver$get_output_dir() FileArchiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"RDSArchiver — FileArchiver","text":"Returns FileArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"RDSArchiver — FileArchiver","text":"FileArchiver object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"RDSArchiver — FileArchiver","text":"Finalizes FileArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"method-get-output-dir-","dir":"Reference","previous_headings":"","what":"Method get_output_dir()","title":"RDSArchiver — FileArchiver","text":"get output_dir field","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"RDSArchiver — FileArchiver","text":"character output_dir field path.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"RDSArchiver — FileArchiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"RDSArchiver — FileArchiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileArchiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"## ------------------------------------------------ ## Method `FileArchiver$new` ## ------------------------------------------------ FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new() #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function () #> write: function () #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534439211 ## ------------------------------------------------ ## Method `FileArchiver$get_output_dir` ## ------------------------------------------------ FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534439360\""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"FileBlock — FileBlock","title":"FileBlock — FileBlock","text":"FileBlock FileBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"FileBlock — FileBlock","text":"teal.reporter::ContentBlock -> FileBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"FileBlock — FileBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$initialize() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"FileBlock — FileBlock","text":"FileBlock$finalize() FileBlock$from_list() FileBlock$to_list() FileBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"FileBlock — FileBlock","text":"finalize FileBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"FileBlock — FileBlock","text":"Removes temporary file created constructor.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"FileBlock — FileBlock","text":"Create FileBlock list. list contain one named field, \"basename\".","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$from_list(x, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"x named list one field \"basename\", name file. output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"FileBlock — FileBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() file_path <- tempfile(fileext = \".png\") saveRDS(iris, file_path) block$from_list(list(basename = basename(file_path)), dirname(file_path))"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"FileBlock — FileBlock","text":"Convert FileBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"FileBlock — FileBlock","text":"named list basename file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() block$to_list(tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"FileBlock — FileBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/FileBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"## ------------------------------------------------ ## Method `FileBlock$from_list` ## ------------------------------------------------ FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() file_path <- tempfile(fileext = \".png\") saveRDS(iris, file_path) block$from_list(list(basename = basename(file_path)), dirname(file_path)) ## ------------------------------------------------ ## Method `FileBlock$to_list` ## ------------------------------------------------ FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() block$to_list(tempdir()) #> $basename #> character(0) #>"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":null,"dir":"Reference","previous_headings":"","what":"JSONArchiver — JSONArchiver","title":"JSONArchiver — JSONArchiver","text":"JSONArchiver JSONArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"JSONArchiver — JSONArchiver","text":"teal.reporter::Archiver -> teal.reporter::FileArchiver -> JSONArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"JSONArchiver — JSONArchiver","text":"teal.reporter::FileArchiver$finalize() teal.reporter::FileArchiver$get_output_dir() teal.reporter::FileArchiver$initialize()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"JSONArchiver — JSONArchiver","text":"JSONArchiver$write() JSONArchiver$read() JSONArchiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"method-write-","dir":"Reference","previous_headings":"","what":"Method write()","title":"JSONArchiver — JSONArchiver","text":"write Reporter instance JSONArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$write(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"JSONArchiver — JSONArchiver","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) archiver$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"method-read-","dir":"Reference","previous_headings":"","what":"Method read()","title":"JSONArchiver — JSONArchiver","text":"read Reporter instance directory JSONArchiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$read(path = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"path character(1) path directory proper files.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"JSONArchiver — JSONArchiver","text":"Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) archiver$get_output_dir() archiver$read()$get_cards()[[1]]$get_content() Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") blocks <- Reporter$new() blocks <- blocks$from_reporter(archiver$read())$get_blocks() Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") doc <- Renderer$new()$render(blocks)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"JSONArchiver — JSONArchiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/JSONArchiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"## ------------------------------------------------ ## Method `JSONArchiver$write` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function (path = NULL) #> write: function (reporter) #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534447062 archiver$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534447062\" ## ------------------------------------------------ ## Method `JSONArchiver$read` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function (path = NULL) #> write: function (reporter) #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534448535 archiver$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534448535\" archiver$read()$get_cards()[[1]]$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf63da3e56.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") blocks <- Reporter$new() blocks <- blocks$from_reporter(archiver$read())$get_blocks() Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") doc <- Renderer$new()$render(blocks)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"NewpageBlock — NewpageBlock","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"NewpageBlock — NewpageBlock","text":"teal.reporter::ContentBlock -> NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"NewpageBlock — NewpageBlock","text":"teal.reporter::ContentBlock$from_list() teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content() teal.reporter::ContentBlock$to_list()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock$new() NewpageBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"NewpageBlock — NewpageBlock","text":"Returns NewpageBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"NewpageBlock — NewpageBlock","text":"Returns NewpageBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") block <- NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"NewpageBlock — NewpageBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"NewpageBlock — NewpageBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/NewpageBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"NewpageBlock — NewpageBlock","text":"","code":"## ------------------------------------------------ ## Method `NewpageBlock$new` ## ------------------------------------------------ NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") block <- NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"RcodeBlock — RcodeBlock","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"RcodeBlock — RcodeBlock","text":"teal.reporter::ContentBlock -> RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"RcodeBlock — RcodeBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock$new() RcodeBlock$set_params() RcodeBlock$get_params() RcodeBlock$get_available_params() RcodeBlock$from_list() RcodeBlock$to_list() RcodeBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"RcodeBlock — RcodeBlock","text":"Returns RcodeBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$new(content = character(0), ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"content (character(1) character(0)) string assigned RcodeBlock ... rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"RcodeBlock — RcodeBlock","text":"Returns RcodeBlock object content parameters.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-set-params-","dir":"Reference","previous_headings":"","what":"Method set_params()","title":"RcodeBlock — RcodeBlock","text":"Sets parameters RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$set_params(params)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"params (list) rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"RcodeBlock — RcodeBlock","text":"parameters bearing rendering block.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$set_params(list(echo = TRUE))"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-get-params-","dir":"Reference","previous_headings":"","what":"Method get_params()","title":"RcodeBlock — RcodeBlock","text":"Returns parameters RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$get_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"character parameters RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-get-available-params-","dir":"Reference","previous_headings":"","what":"Method get_available_params()","title":"RcodeBlock — RcodeBlock","text":"Returns array parameters available RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$get_available_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"character array parameters","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_available_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"RcodeBlock — RcodeBlock","text":"Create RcodeBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"x named list two fields c(\"text\", \"params\"). Use get_available_params method get possible parameters.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$from_list(list(text = \"sth\", params = list()))"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"RcodeBlock — RcodeBlock","text":"Convert RcodeBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"named list text params.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"RcodeBlock — RcodeBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/RcodeBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"## ------------------------------------------------ ## Method `RcodeBlock$new` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() ## ------------------------------------------------ ## Method `RcodeBlock$set_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$set_params(list(echo = TRUE)) ## ------------------------------------------------ ## Method `RcodeBlock$get_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_params() #> list() ## ------------------------------------------------ ## Method `RcodeBlock$get_available_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_available_params() #> [1] \"eval\" \"echo\" \"results\" \"tidy\" #> [5] \"tidy.opts\" \"collapse\" \"prompt\" \"comment\" #> [9] \"highlight\" \"size\" \"background\" \"strip.white\" #> [13] \"cache\" \"cache.path\" \"cache.vars\" \"cache.lazy\" #> [17] \"dependson\" \"autodep\" \"cache.rebuild\" \"fig.keep\" #> [21] \"fig.show\" \"fig.align\" \"fig.path\" \"dev\" #> [25] \"dev.args\" \"dpi\" \"fig.ext\" \"fig.width\" #> [29] \"fig.height\" \"fig.env\" \"fig.cap\" \"fig.scap\" #> [33] \"fig.lp\" \"fig.subcap\" \"fig.pos\" \"out.width\" #> [37] \"out.height\" \"out.extra\" \"fig.retina\" \"external\" #> [41] \"sanitize\" \"interval\" \"aniopts\" \"warning\" #> [45] \"error\" \"message\" \"render\" \"ref.label\" #> [49] \"child\" \"engine\" \"split\" \"include\" #> [53] \"purl\" ## ------------------------------------------------ ## Method `RcodeBlock$from_list` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$from_list(list(text = \"sth\", params = list())) ## ------------------------------------------------ ## Method `RcodeBlock$to_list` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$to_list() #> $text #> character(0) #> #> $params #> list() #>"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":null,"dir":"Reference","previous_headings":"","what":"Renderer — Renderer","title":"Renderer — Renderer","text":"Renderer Renderer","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Renderer — Renderer","text":"Renderer$new() Renderer$finalize() Renderer$renderRmd() Renderer$render() Renderer$get_output_dir() Renderer$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Renderer — Renderer","text":"Returns Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"Returns Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") Renderer$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"Renderer — Renderer","text":"Finalizes Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-renderrmd-","dir":"Reference","previous_headings":"","what":"Method renderRmd()","title":"Renderer — Renderer","text":"getting Rmd text easily rendered later.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$renderRmd( blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\") )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"blocks list c(\"TextBlock\", \"PictureBlock\", \"NewpageBlock\") objects. yaml_header character rmarkdown yaml header. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character Rmd text (yaml header + body), ready rendered.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$renderRmd(reporter$get_blocks(), yaml_header)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-render-","dir":"Reference","previous_headings":"","what":"Method render()","title":"Renderer — Renderer","text":"Renders content Report output file","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$render( blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\"), ... )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"blocks list c(\"TextBlock\", \"PictureBlock\", \"NewpageBlock\") objects. yaml_header character rmarkdown yaml header. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. ... rmarkdown::render arguments, input output_dir updated.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"details-2","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character path output","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\")$new() Reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$render(Reporter$get_blocks(), yaml_header)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-get-output-dir-","dir":"Reference","previous_headings":"","what":"Method get_output_dir()","title":"Renderer — Renderer","text":"get output_dir field","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character output_dir field path.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\")$new() Renderer$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Renderer — Renderer","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Renderer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"## ------------------------------------------------ ## Method `Renderer$new` ## ------------------------------------------------ Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") Renderer$new() #> #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> render: function (blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\"), #> renderRmd: function (blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\")) #> Private: #> block2md: function (block) #> output_dir: /tmp/RtmpaeuLcj/report_202401231534462941 #> pictureBlock2md: function (block) #> rcodeBlock2md: function (block) #> report_type: NULL #> tableBlock2md: function (block) #> textBlock2md: function (block) ## ------------------------------------------------ ## Method `Renderer$renderRmd` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$renderRmd(reporter$get_blocks(), yaml_header) ## ------------------------------------------------ ## Method `Renderer$render` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\")$new() Reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$render(Reporter$get_blocks(), yaml_header) ## ------------------------------------------------ ## Method `Renderer$get_output_dir` ## ------------------------------------------------ Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\")$new() Renderer$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/report_202401231534494419\""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":null,"dir":"Reference","previous_headings":"","what":"ReportCard — ReportCard","title":"ReportCard — ReportCard","text":"R6 class supports creating report card containing text, plot, table meta data blocks can appended rendered form report output shiny app.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ReportCard — ReportCard","text":"ReportCard$new() ReportCard$append_table() ReportCard$append_plot() ReportCard$append_text() ReportCard$append_rcode() ReportCard$append_content() ReportCard$get_content() ReportCard$reset() ReportCard$get_metadata() ReportCard$append_metadata() ReportCard$get_name() ReportCard$set_name() ReportCard$to_list() ReportCard$from_list() ReportCard$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ReportCard — ReportCard","text":"Returns ReportCard object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"ReportCard object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-table-","dir":"Reference","previous_headings":"","what":"Method append_table()","title":"ReportCard — ReportCard","text":"Appends table ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_table(table)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"table appended table","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_table(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-plot-","dir":"Reference","previous_headings":"","what":"Method append_plot()","title":"ReportCard — ReportCard","text":"Appends plot ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_plot(plot, dim = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"plot appended plot dim integer vector width height pixels.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-text-","dir":"Reference","previous_headings":"","what":"Method append_text()","title":"ReportCard — ReportCard","text":"Appends paragraph text ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_text(text, style = TextBlock$new()$get_available_styles()[1])"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"text (character(0) character(1)) text style (character(1)) style paragraph. One : default, header, verbatim","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"A paragraph of default text\")"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-rcode-","dir":"Reference","previous_headings":"","what":"Method append_rcode()","title":"ReportCard — ReportCard","text":"Appends rmarkdown R chunk ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_rcode(text, ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"text (character(0) character(1)) text ... rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_rcode(\"2+2\", echo = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-content-","dir":"Reference","previous_headings":"","what":"Method append_content()","title":"ReportCard — ReportCard","text":"Appends ContentBlock ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"content (ContentBlock)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") card <- ReportCard$new()$append_content(NewpageBlock$new())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"ReportCard — ReportCard","text":"Returns content ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"list() list TableBlock, TextBlock PictureBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-6","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"ReportCard — ReportCard","text":"Removes objects added ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$reset()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"ReportCard — ReportCard","text":"Returns metadata ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"named list list elements.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-7","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-append-metadata-","dir":"Reference","previous_headings":"","what":"Method append_metadata()","title":"ReportCard — ReportCard","text":"Appends metadata ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_metadata(key, value)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"key (character(1)) name meta data. value value meta data.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-8","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() card$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-get-name-","dir":"Reference","previous_headings":"","what":"Method get_name()","title":"ReportCard — ReportCard","text":"get Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"character Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-9","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()$set_name(\"NAME\")$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-set-name-","dir":"Reference","previous_headings":"","what":"Method set_name()","title":"ReportCard — ReportCard","text":"set Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$set_name(name)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"name character Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-10","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()$set_name(\"NAME\")$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"ReportCard — ReportCard","text":"Convert ReportCard list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"output_dir character path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"named list ReportCard representation.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-11","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() card$to_list(tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"ReportCard — ReportCard","text":"Create ReportCard list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$from_list(card, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"card named list ReportCard representation. output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"examples-12","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ReportCard — ReportCard","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/ReportCard.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"## ------------------------------------------------ ## Method `ReportCard$new` ## ------------------------------------------------ card <- ReportCard$new() ## ------------------------------------------------ ## Method `ReportCard$append_table` ## ------------------------------------------------ card <- ReportCard$new()$append_table(iris) ## ------------------------------------------------ ## Method `ReportCard$append_plot` ## ------------------------------------------------ card <- ReportCard$new()$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ## ------------------------------------------------ ## Method `ReportCard$append_text` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"A paragraph of default text\") ## ------------------------------------------------ ## Method `ReportCard$append_rcode` ## ------------------------------------------------ card <- ReportCard$new()$append_rcode(\"2+2\", echo = FALSE) ## ------------------------------------------------ ## Method `ReportCard$append_content` ## ------------------------------------------------ NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") card <- ReportCard$new()$append_content(NewpageBlock$new()) ## ------------------------------------------------ ## Method `ReportCard$get_content` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> ## ------------------------------------------------ ## Method `ReportCard$get_metadata` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_metadata() #> $rc #> [1] \"a <- 2 + 2\" #> ## ------------------------------------------------ ## Method `ReportCard$append_metadata` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf86a4dab.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> card$get_metadata() #> $lm #> #> Call: #> lm(formula = Ozone ~ Solar.R, data = airquality) #> #> Coefficients: #> (Intercept) Solar.R #> 18.5987 0.1272 #> #> ## ------------------------------------------------ ## Method `ReportCard$get_name` ## ------------------------------------------------ ReportCard$new()$set_name(\"NAME\")$get_name() #> [1] \"NAME\" ## ------------------------------------------------ ## Method `ReportCard$set_name` ## ------------------------------------------------ ReportCard$new()$set_name(\"NAME\")$get_name() #> [1] \"NAME\" ## ------------------------------------------------ ## Method `ReportCard$to_list` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf131a5dc6.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> card$to_list(tempdir()) #> $blocks #> $blocks$TextBlock #> $blocks$TextBlock$text #> [1] \"Some text\" #> #> $blocks$TextBlock$style #> [1] \"default\" #> #> #> $blocks$PictureBlock #> $blocks$PictureBlock$basename #> [1] \"file1bf131a5dc6.png\" #> #> #> $blocks$TextBlock #> $blocks$TextBlock$text #> [1] \"Some text\" #> #> $blocks$TextBlock$style #> [1] \"default\" #> #> #> #> $metadata #> $metadata$lm #> #> Call: #> lm(formula = Ozone ~ Solar.R, data = airquality) #> #> Coefficients: #> (Intercept) Solar.R #> 18.5987 0.1272 #> #> #> ## ------------------------------------------------ ## Method `ReportCard$from_list` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf650dadd2.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter — Reporter","title":"Reporter — Reporter","text":"R6 class stores manages report cards.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Reporter — Reporter","text":"function used shiny reactive context.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Reporter — Reporter","text":"Reporter$new() Reporter$append_cards() Reporter$get_cards() Reporter$get_blocks() Reporter$reset() Reporter$remove_cards() Reporter$swap_cards() Reporter$get_reactive_add_card() Reporter$get_metadata() Reporter$append_metadata() Reporter$from_reporter() Reporter$to_list() Reporter$from_list() Reporter$to_jsondir() Reporter$from_jsondir() Reporter$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Reporter — Reporter","text":"Returns Reporter object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"Reporter object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- teal.reporter::Reporter$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-append-cards-","dir":"Reference","previous_headings":"","what":"Method append_cards()","title":"Reporter — Reporter","text":"Appends table Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$append_cards(cards)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"cards ReportCard list objects","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2))"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-get-cards-","dir":"Reference","previous_headings":"","what":"Method get_cards()","title":"Reporter — Reporter","text":"Returns cards Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_cards()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"list() list ReportCard","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_cards()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-get-blocks-","dir":"Reference","previous_headings":"","what":"Method get_blocks()","title":"Reporter — Reporter","text":"Returns blocks ReportCard Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_blocks(sep = NewpageBlock$new())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"sep element inserted content element Reporter. Pass NULL return content without additional elements. Default: NewpageBlock$new()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"list() list TableBlock, TextBlock, PictureBlock NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_blocks()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"Reporter — Reporter","text":"Removes ReportCard objects added Reporter. Additionally metadata removed.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$reset()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-remove-cards-","dir":"Reference","previous_headings":"","what":"Method remove_cards()","title":"Reporter — Reporter","text":"remove specific Card Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$remove_cards(ids = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"ids integer indexes cards","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-swap-cards-","dir":"Reference","previous_headings":"","what":"Method swap_cards()","title":"Reporter — Reporter","text":"swap two cards Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$swap_cards(start, end)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"start integer index first card end integer index second card","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-get-reactive-add-card-","dir":"Reference","previous_headings":"","what":"Method get_reactive_add_card()","title":"Reporter — Reporter","text":"get value reactive value add card","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_reactive_add_card()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"reactive_add_card field value","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"shiny::isolate(Reporter$new()$get_reactive_add_card())"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"Reporter — Reporter","text":"get metadata Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"metadata","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-append-metadata-","dir":"Reference","previous_headings":"","what":"Method append_metadata()","title":"Reporter — Reporter","text":"Appends metadata Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$append_metadata(meta)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"meta (list) metadata.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-6","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-from-reporter-","dir":"Reference","previous_headings":"","what":"Method from_reporter()","title":"Reporter — Reporter","text":"Create/Recreate Reporter another Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_reporter(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-7","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() reporter$from_reporter(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"Reporter — Reporter","text":"Convert Reporter list transfer files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"named list Reporter representation","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-8","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") dir.create(tmp_dir) reporter$to_list(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"Reporter — Reporter","text":"Create/Recreate Reporter list directory files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_list(rlist, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"rlist named list Reporter representation. output_dir character(1) path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-9","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") unlink(tmp_dir, recursive = TRUE) dir.create(tmp_dir) reporter$from_list(reporter$to_list(tmp_dir), tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-to-jsondir-","dir":"Reference","previous_headings":"","what":"Method to_jsondir()","title":"Reporter — Reporter","text":"Create/Recreate Reporter directory JSON file static files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$to_jsondir(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files copied, JSON statics.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-10","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) reporter$to_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-from-jsondir-","dir":"Reference","previous_headings":"","what":"Method from_jsondir()","title":"Reporter — Reporter","text":"Create/Recreate Reporter directory JSON file static files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_jsondir(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files, JSON statics.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"returns-14","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"examples-11","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) unlink(list.files(tmp_dir, recursive = TRUE)) reporter$to_jsondir(tmp_dir) reporter$from_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Reporter — Reporter","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/Reporter.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"## ------------------------------------------------ ## Method `Reporter$new` ## ------------------------------------------------ reporter <- teal.reporter::Reporter$new() ## ------------------------------------------------ ## Method `Reporter$append_cards` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) ## ------------------------------------------------ ## Method `Reporter$get_cards` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_cards() #> [[1]] #> #> Public: #> append_content: function (content) #> append_metadata: function (key, value) #> append_plot: function (plot, dim = NULL) #> append_rcode: function (text, ...) #> append_table: function (table) #> append_text: function (text, style = TextBlock$new()$get_available_styles()[1]) #> clone: function (deep = FALSE) #> from_list: function (card, output_dir) #> get_content: function () #> get_metadata: function () #> get_name: function () #> initialize: function () #> reset: function () #> set_name: function (name) #> to_list: function (output_dir) #> Private: #> content: list #> deep_clone: function (name, value) #> metadata: list #> name: #> #> [[2]] #> #> Public: #> append_content: function (content) #> append_metadata: function (key, value) #> append_plot: function (plot, dim = NULL) #> append_rcode: function (text, ...) #> append_table: function (table) #> append_text: function (text, style = TextBlock$new()$get_available_styles()[1]) #> clone: function (deep = FALSE) #> from_list: function (card, output_dir) #> get_content: function () #> get_metadata: function () #> get_name: function () #> initialize: function () #> reset: function () #> set_name: function (name) #> to_list: function (output_dir) #> Private: #> content: list #> deep_clone: function (name, value) #> metadata: list #> name: #> ## ------------------------------------------------ ## Method `Reporter$get_blocks` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_blocks() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf7d4268e6.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[4]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_content: function () #> initialize: function () #> set_content: function (content) #> to_list: function () #> Private: #> content: #> \\newpage #> #> deep_clone: function (name, value) #> #> [[5]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[6]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[7]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> initialize: function (table) #> set_content: function (content) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf2c8af380.rds #> deep_clone: function (name, value) #> supported_tables: data.frame rtables TableTree ElementaryTable listing_df #> #> [[8]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> initialize: function (table) #> set_content: function (content) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf7c4e8b6a.rds #> deep_clone: function (name, value) #> supported_tables: data.frame rtables TableTree ElementaryTable listing_df #> ## ------------------------------------------------ ## Method `Reporter$get_reactive_add_card` ## ------------------------------------------------ shiny::isolate(Reporter$new()$get_reactive_add_card()) #> [1] 0 ## ------------------------------------------------ ## Method `Reporter$get_metadata` ## ------------------------------------------------ reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata() #> $sth #> [1] \"sth\" #> ## ------------------------------------------------ ## Method `Reporter$append_metadata` ## ------------------------------------------------ reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata() #> $sth #> [1] \"sth\" #> ## ------------------------------------------------ ## Method `Reporter$from_reporter` ## ------------------------------------------------ reporter <- Reporter$new() reporter$from_reporter(reporter) ## ------------------------------------------------ ## Method `Reporter$to_list` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") dir.create(tmp_dir) reporter$to_list(tmp_dir) #> $version #> [1] \"1\" #> #> $cards #> list() #> #> $metadata #> list() #> ## ------------------------------------------------ ## Method `Reporter$from_list` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") unlink(tmp_dir, recursive = TRUE) dir.create(tmp_dir) reporter$from_list(reporter$to_list(tmp_dir), tmp_dir) ## ------------------------------------------------ ## Method `Reporter$to_jsondir` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) reporter$to_jsondir(tmp_dir) #> [1] \"/tmp/RtmpaeuLcj/jsondir\" ## ------------------------------------------------ ## Method `Reporter$from_jsondir` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) #> Warning: '/tmp/RtmpaeuLcj/jsondir' already exists unlink(list.files(tmp_dir, recursive = TRUE)) reporter$to_jsondir(tmp_dir) #> [1] \"/tmp/RtmpaeuLcj/jsondir\" reporter$from_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"TableBlock — TableBlock","title":"TableBlock — TableBlock","text":"TableBlock TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"TableBlock — TableBlock","text":"teal.reporter::ContentBlock -> teal.reporter::FileBlock -> TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"TableBlock — TableBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::FileBlock$finalize() teal.reporter::FileBlock$from_list() teal.reporter::FileBlock$to_list()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"TableBlock — TableBlock","text":"TableBlock$new() TableBlock$set_content() TableBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"TableBlock — TableBlock","text":"Returns new TableBlock object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$new(table)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"table (data.frame, rtables, TableTree, ElementaryTable, listing_df) table assigned TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"TableBlock — TableBlock","text":"TableBlock object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"method-set-content-","dir":"Reference","previous_headings":"","what":"Method set_content()","title":"TableBlock — TableBlock","text":"Sets content TableBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$set_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"content (data.frame, rtables, TableTree, ElementaryTable, listing_df) table assigned TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"TableBlock — TableBlock","text":"throws argument table-like object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"TableBlock — TableBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TableBlock — TableBlock","text":"","code":"TableBlock <- getFromNamespace(\"TableBlock\", \"teal.reporter\") block <- TableBlock$new() block$set_content(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"TableBlock — TableBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TableBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TableBlock — TableBlock","text":"","code":"## ------------------------------------------------ ## Method `TableBlock$set_content` ## ------------------------------------------------ TableBlock <- getFromNamespace(\"TableBlock\", \"teal.reporter\") block <- TableBlock$new() block$set_content(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"TextBlock — TextBlock","title":"TextBlock — TextBlock","text":"TextBlock TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"TextBlock — TextBlock","text":"teal.reporter::ContentBlock -> TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"TextBlock — TextBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"TextBlock — TextBlock","text":"TextBlock$new() TextBlock$set_style() TextBlock$get_style() TextBlock$get_available_styles() TextBlock$from_list() TextBlock$to_list() TextBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"TextBlock — TextBlock","text":"Returns TextBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$new(content = character(0), style = private$styles[1])"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"content (character(1) character(0)) string assigned TextBlock style (character(1)) one : \"default\", \"header2\", \"header3\" \"verbatim\"","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"TextBlock — TextBlock","text":"Returns TextBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-set-style-","dir":"Reference","previous_headings":"","what":"Method set_style()","title":"TextBlock — TextBlock","text":"Sets style TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$set_style(style)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"style (character(1)) one : \"default\", \"header2\", \"header3\" \"verbatim\"","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"TextBlock — TextBlock","text":"style bearing rendering block.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$set_style(\"header2\")"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-get-style-","dir":"Reference","previous_headings":"","what":"Method get_style()","title":"TextBlock — TextBlock","text":"Returns style TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$get_style()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"character(1) style TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_style()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-get-available-styles-","dir":"Reference","previous_headings":"","what":"Method get_available_styles()","title":"TextBlock — TextBlock","text":"Returns array styles available TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$get_available_styles()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"character array styles","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_available_styles()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"TextBlock — TextBlock","text":"Create TextBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"x named list two fields c(\"text\", \"style\"). Use get_available_styles method get possible styles.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$from_list(list(text = \"sth\", style = \"default\"))"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"TextBlock — TextBlock","text":"Convert TextBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"named list text style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"TextBlock — TextBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/TextBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"## ------------------------------------------------ ## Method `TextBlock$new` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() ## ------------------------------------------------ ## Method `TextBlock$set_style` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$set_style(\"header2\") ## ------------------------------------------------ ## Method `TextBlock$get_style` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_style() #> [1] \"default\" ## ------------------------------------------------ ## Method `TextBlock$get_available_styles` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_available_styles() #> [1] \"default\" \"header2\" \"header3\" \"verbatim\" ## ------------------------------------------------ ## Method `TextBlock$from_list` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$from_list(list(text = \"sth\", style = \"default\")) ## ------------------------------------------------ ## Method `TextBlock$to_list` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$to_list() #> $text #> character(0) #> #> $style #> [1] \"default\" #>"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Card Button Server — add_card_button_srv","title":"Add Card Button Server — add_card_button_srv","text":"server adding views/cards Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Card Button Server — add_card_button_srv","text":"","code":"add_card_button_srv(id, reporter, card_fun)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Card Button Server — add_card_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance. card_fun function returns ReportCard instance. can optional card, comment label parameters. card parameter added, ReportCard instance created user. Use comment parameter pass value whenever prefer card$append_text() - card_fun comment parameter, comment Add Card UI module added end content card. label parameter provided, can use customize appearance card name use specify card content card$append_text() - card_fun label parameter, card name set name passed Add Card UI module, text added content card.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Card Button Server — add_card_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Add Card Button Server — add_card_button_srv","text":"module allows using child ReportCard instead ReportCard. properly support , instance child class must passed default value card argument card_fun function. See :","code":"CustomReportCard <- R6::R6Class( # nolint: object_name_linter. classname = \"CustomReportCard\", inherit = teal.reporter::ReportCard ) custom_function <- function(card = CustomReportCard$new()) { card }"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Card Button User Interface — add_card_button_ui","title":"Add Card Button User Interface — add_card_button_ui","text":"button adding views/cards Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Card Button User Interface — add_card_button_ui","text":"","code":"add_card_button_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Card Button User Interface — add_card_button_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/add_card_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Card Button User Interface — add_card_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/as_yaml_auto.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"parse named list Rmd yaml header, developer gets automatically tabulated Rmd yaml header. non nested (flat) list processed, nested list directly processed yaml::.yaml function. Rmd yaml header fields vector supported, c(\"author\", \"date\", \"title\", \"subtitle\", \"abstract\", \"keywords\", \"subject\", \"description\", \"category\", \"lang\"). Moreover outputfield types rmarkdown package arguments supported.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/as_yaml_auto.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"","code":"as_yaml_auto( input_list, as_header = TRUE, convert_logi = TRUE, multi_output = FALSE, silent = FALSE )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/as_yaml_auto.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"input_list named list non nested slots names values compatible Rmd yaml header. as_header logical optionally wrap result internal md_header(), default TRUE. convert_logi logical convert character values logical, recognized quoted yaml logical values , default TRUE. multi_output logical multi output slots input argument, default FALSE. silent logical suppress messages warnings, default FALSE.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/as_yaml_auto.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"character rmd_yaml_header class, result yaml::.yaml, optionally wrapped internal md_header().","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/as_yaml_auto.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"","code":"# nested so using yaml::as.yaml directly as_yaml_auto( list(author = \"\", output = list(pdf_document = list(toc = TRUE))) ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> --- # auto parsing for a flat list, like shiny input input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE) as_yaml_auto(input) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = \"TRUE\")) #> The 'TRUE' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list( author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE, wrong = 2 )) #> Warning: Not recognized and skipped arguments: wrong #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = 2), silent = TRUE ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: 2.0 #> --- input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = \"True\") as_yaml_auto(input) #> The 'True' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, convert_logi = TRUE, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, convert_logi = FALSE, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: 'True' #> --- as_yaml_auto( list( author = \"\", output = \"pdf_document\", output = \"html_document\", toc = TRUE, keep_tex = TRUE ), multi_output = TRUE ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> html_document: #> toc: yes #> --- as_yaml_auto( list( author = \"\", output = \"pdf_document\", output = \"html_document\", toc = \"True\", keep_tex = TRUE ), multi_output = TRUE ) #> The 'True' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> html_document: #> toc: yes #> ---"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/conv_str_logi.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a character of a yaml boolean to a logical value — conv_str_logi","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"convert character yaml boolean logical value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/conv_str_logi.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"","code":"conv_str_logi( input, name = \"\", pos_logi = c(\"TRUE\", \"true\", \"True\", \"yes\", \"y\", \"Y\", \"on\"), neg_logi = c(\"FALSE\", \"false\", \"False\", \"no\", \"n\", \"N\", \"off\"), silent = TRUE )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/conv_str_logi.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"input character name charcter pos_logi character vector yaml values treated TRUE. neg_logi character vector yaml values treated FALSE. silent logical suppress messages warnings.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/conv_str_logi.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"input argument appropriate logical value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/conv_str_logi.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"","code":"conv_str_logi <- getFromNamespace(\"conv_str_logi\", \"teal.reporter\") conv_str_logi(\"TRUE\") #> [1] TRUE conv_str_logi(\"True\") #> [1] TRUE conv_str_logi(\"off\") #> [1] FALSE conv_str_logi(\"n\") #> [1] FALSE conv_str_logi(\"sth\") #> [1] \"sth\""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Download Button Server — download_report_button_srv","title":"Download Button Server — download_report_button_srv","text":"server downloading Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download Button Server — download_report_button_srv","text":"","code":"download_report_button_srv( id, reporter, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download Button Server — download_report_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download Button Server — download_report_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download Button Server — download_report_button_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Download Button Reporter User Interface — download_report_button_ui","title":"Download Button Reporter User Interface — download_report_button_ui","text":"button downloading Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download Button Reporter User Interface — download_report_button_ui","text":"","code":"download_report_button_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download Button Reporter User Interface — download_report_button_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/download_report_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download Button Reporter User Interface — download_report_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_bs_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bootstrap current version — get_bs_version","title":"Get bootstrap current version — get_bs_version","text":"Get bootstrap current version","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_bs_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bootstrap current version — get_bs_version","text":"","code":"get_bs_version()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_bs_version.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Get bootstrap current version — get_bs_version","text":"work properly mainly inside tag .renderHook","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_yaml_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"Parses yaml text, extracting specified field. Returns list names list; otherwise, field .","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_yaml_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"","code":"get_yaml_field(yaml_text, field_name)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_yaml_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"yaml_text character vector containing yaml text. field_name name field extract.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/get_yaml_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"field list, returns names elements list; otherwise, returns extracted field.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/md_header.html","id":null,"dir":"Reference","previous_headings":"","what":"wrap a yaml string to the markdown header — md_header","title":"wrap a yaml string to the markdown header — md_header","text":"wrap yaml string markdown header.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/md_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"wrap a yaml string to the markdown header — md_header","text":"","code":"md_header(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/md_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"wrap a yaml string to the markdown header — md_header","text":"x character yaml formatted string.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/md_header.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"wrap a yaml string to the markdown header — md_header","text":"","code":"yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(pdf_document = list(keep_tex = TRUE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") md_header(yaml::as.yaml(yaml)) #> [1] \"---\\nauthor: \\\"NEST\\\"\\ntitle: \\\"Report\\\"\\ndate: \\\"07/04/2019\\\"\\noutput:\\n pdf_document:\\n keep_tex: yes\\n---\\n\""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/panel_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Panel group widget — panel_item","text":"","code":"panel_item(title, ..., collapsed = TRUE, input_id = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/panel_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Panel group widget — panel_item","text":"title (character) title panel ... content panel collapsed (logical, optional) whether initially collapse panel input_id (character, optional) name panel item element. supplied, register shiny input variable indicates whether panel item open collapsed accessed input$input_id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/panel_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Panel group widget — panel_item","text":"(shiny.tag)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/print.rmd_yaml_header.html","id":null,"dir":"Reference","previous_headings":"","what":"Print method for the yaml_header class — print.rmd_yaml_header","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"Print method yaml_header class.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/print.rmd_yaml_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"","code":"# S3 method for rmd_yaml_header print(x, ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/print.rmd_yaml_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"x rmd_yaml_header class object. ... optional text.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/print.rmd_yaml_header.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"","code":"input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE) out <- as_yaml_auto(input) out #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- print(out) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> ---"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/report_render_and_compress.html","id":null,"dir":"Reference","previous_headings":"","what":"Render the Report — report_render_and_compress","title":"Render the Report — report_render_and_compress","text":"render report zip created directory.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/report_render_and_compress.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render the Report — report_render_and_compress","text":"","code":"report_render_and_compress( reporter, input_list, global_knitr, file = tempdir() )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/report_render_and_compress.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render the Report — report_render_and_compress","text":"reporter Reporter instance. input_list list like shiny input converted regular named list. global_knitr list global knitr parameters, like echo. local parameter set priority. file character copy returned directory.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/report_render_and_compress.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render the Report — report_render_and_compress","text":"file argument, invisibly.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_download_inputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the custom list of User Interface inputs — reporter_download_inputs","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"Get custom list User Interface inputs","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_download_inputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"","code":"reporter_download_inputs(rmd_yaml_args, rmd_output, showrcode, session)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_download_inputs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Previewer Server — reporter_previewer_srv","title":"Reporter Previewer Server — reporter_previewer_srv","text":"server supporting functionalities reporter previewer details see vignette: vignette(\"previewerReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Previewer Server — reporter_previewer_srv","text":"","code":"reporter_previewer_srv( id, reporter, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Previewer Server — reporter_previewer_srv","text":"id character(1) shiny module's id. reporter Reporter instance global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Reporter Previewer Server — reporter_previewer_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Previewer User Interface — reporter_previewer_ui","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"reporter previewer user interface visualize manipulate already added report Cards","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"","code":"reporter_previewer_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reporter_previewer_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Button Server — reset_report_button_srv","title":"Reset Button Server — reset_report_button_srv","text":"server resetting Report content. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Button Server — reset_report_button_srv","text":"","code":"reset_report_button_srv(id, reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Button Server — reset_report_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Button Server — reset_report_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Button Reporter User Interface — reset_report_button_ui","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"button resetting report content. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"","code":"reset_report_button_ui(id, label = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"id character(1) shiny module's id. label character(1) label icon. default NULL.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/reset_report_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_output_arguments.html","id":null,"dir":"Reference","previous_headings":"","what":"Get document output arguments from the rmarkdown package — rmd_output_arguments","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"get document output arguments rmarkdown package","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_output_arguments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"","code":"rmd_output_arguments(output_name, default_values = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_output_arguments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"output_name character rmarkdown output name. default_values logical return default values argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_output_arguments.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"","code":"rmd_output_arguments(\"pdf_document\") #> [1] \"toc\" \"toc_depth\" \"number_sections\" #> [4] \"fig_width\" \"fig_height\" \"fig_crop\" #> [7] \"fig_caption\" \"dev\" \"df_print\" #> [10] \"highlight\" \"template\" \"keep_tex\" #> [13] \"keep_md\" \"latex_engine\" \"citation_package\" #> [16] \"includes\" \"md_extensions\" \"output_extensions\" #> [19] \"pandoc_args\" \"extra_dependencies\" rmd_output_arguments(\"pdf_document\", TRUE) #> $toc #> [1] FALSE #> #> $toc_depth #> [1] 2 #> #> $number_sections #> [1] FALSE #> #> $fig_width #> [1] 6.5 #> #> $fig_height #> [1] 4.5 #> #> $fig_crop #> [1] \"auto\" #> #> $fig_caption #> [1] TRUE #> #> $dev #> [1] \"pdf\" #> #> $df_print #> [1] \"default\" #> #> $highlight #> [1] \"default\" #> #> $template #> [1] \"default\" #> #> $keep_tex #> [1] FALSE #> #> $keep_md #> [1] FALSE #> #> $latex_engine #> [1] \"pdflatex\" #> #> $citation_package #> c(\"default\", \"natbib\", \"biblatex\") #> #> $includes #> NULL #> #> $md_extensions #> NULL #> #> $output_extensions #> NULL #> #> $pandoc_args #> NULL #> #> $extra_dependencies #> NULL #>"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_outputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get document output types from the rmarkdown package — rmd_outputs","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"get document output types rmarkdown package.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_outputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"","code":"rmd_outputs()"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_outputs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"character vector.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/rmd_outputs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"","code":"rmd_outputs() #> [1] \"beamer_presentation\" \"context_document\" #> [3] \"github_document\" \"html_document\" #> [5] \"html_document_base\" \"html_extras_for_document\" #> [7] \"ioslides_presentation\" \"latex_document\" #> [9] \"md_document\" \"odt_document\" #> [11] \"pdf_document\" \"powerpoint_presentation\" #> [13] \"rtf_document\" \"slidy_presentation\" #> [15] \"word_document\""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple Reporter Server — simple_reporter_srv","title":"Simple Reporter Server — simple_reporter_srv","text":"three buttons adding cards, downloading resetting Report. add module add_report_card_simple id, download module download_button_simple id reset module reset_button_simple id. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple Reporter Server — simple_reporter_srv","text":"","code":"simple_reporter_srv( id, reporter, card_fun, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple Reporter Server — simple_reporter_srv","text":"id character(1) shiny module's id. reporter Reporter instance. card_fun function returns ReportCard instance, function card argument optional comment argument. global_knitr list global knitr parameters customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple Reporter Server — simple_reporter_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Simple Reporter Server — simple_reporter_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple Reporter User Interface — simple_reporter_ui","title":"Simple Reporter User Interface — simple_reporter_ui","text":"three buttons adding cards, downloading resetting Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple Reporter User Interface — simple_reporter_ui","text":"","code":"simple_reporter_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple Reporter User Interface — simple_reporter_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple Reporter User Interface — simple_reporter_ui","text":"shiny.tag","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/simple_reporter_ui.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Simple Reporter User Interface — simple_reporter_ui","text":"","code":"if (interactive()) { shiny::shinyApp( ui = shiny::fluidPage(simple_reporter_ui(\"simple\")), server = function(input, output, session) { simple_reporter_srv(\"simple\", Reporter$new(), function(card) card) } ) }"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/split_text_block.html","id":null,"dir":"Reference","previous_headings":"","what":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"Divide text block smaller blocks.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/split_text_block.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"","code":"split_text_block(x, n)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/split_text_block.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"n integer number lines per block block_text character string containing input block text","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/split_text_block.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"List character strings n lines element.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/split_text_block.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"single character string containing text block multiple lines (separated \\n) split multiple strings n less lines .","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/teal.reporter.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporting tools for shiny modules. — teal.reporter","title":"Reporting tools for shiny modules. — teal.reporter","text":"collection tools creating, previewing modifying reports shiny modules.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/reference/teal.reporter.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Reporting tools for shiny modules. — teal.reporter","text":"Maintainer: Dawid Kaledkowski dawid.kaledkowski@roche.com Authors: Maciej Nasinski Konrad Pagacz Mahmoud mahmoud.hallal@roche.com Hallal contributors: F. Hoffmann-La Roche AG [copyright holder, funder]","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/to_flextable.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"Convert content flextable, merge cells colspan > 1 align columns center, row names left Indent row names 10 times indentation","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/to_flextable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"","code":"to_flextable(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/to_flextable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"content Supported formats: data.frame, rtables, TableTree, ElementaryTable, listing_df","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/to_flextable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"(flextable)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/yaml_quoted.html","id":null,"dir":"Reference","previous_headings":"","what":"quoted string for yaml — yaml_quoted","title":"quoted string for yaml — yaml_quoted","text":"add quoted attribute yaml package","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/yaml_quoted.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"quoted string for yaml — yaml_quoted","text":"","code":"yaml_quoted(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/reference/yaml_quoted.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"quoted string for yaml — yaml_quoted","text":"x character","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/reference/yaml_quoted.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"quoted string for yaml — yaml_quoted","text":"","code":"yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(pdf_document = list(keep_tex = TRUE)) ) yaml::as.yaml(yaml) #> [1] \"author: \\\"NEST\\\"\\ntitle: \\\"Report\\\"\\ndate: \\\"07/04/2019\\\"\\noutput:\\n pdf_document:\\n keep_tex: yes\\n\""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"tealreporter-0219015","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.2.1.9015","title":"teal.reporter 0.2.1.9015","text":"add_card_button_srv allows specify card_fun label parameter card’s title & content customization. Supports automatic Rcode formatting using suggested formatR package reports.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"tealreporter-021","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.2.1","title":"teal.reporter 0.2.1","text":"CRAN release: 2023-09-08","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"miscellaneous-0-2-1","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.2.1","text":"Specify minimal version dependent packages. Updated TableBlock convert tables flextables show rendered report. Fixed CRAN requirements first CRAN submission. Removed manual pages non-exported objects. Fixed CRAN requirements first CRAN submission.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"teal.reporter 0.2.0","text":"Added new RcodeBlock block custom rmarkdown r chunk. Added collapsible panel Show R Code previewer. Added additional input needed decide “Show R Code” part rendered report. Added possibility add personalized card name adding card. Added support custom inputs download previewer modules.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"breaking-changes-0-2-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"teal.reporter 0.2.0","text":"Simplified reporter_previewer_ui contain just id argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"enhancements-0-2-0","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"teal.reporter 0.2.0","text":"Changed modal button colors align purpose modals. Updated AddCardModule comment input active cursor adding card. Updated report previewer support preview multiline comment. Added support table contents reporter documents. Added support global knitr options render method Render class. Improved look remove card modal previewer module.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"miscellaneous-0-2-0","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.2.0","text":"Updated append_src method TealReportCard add additional “R Code” Subtitle.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"new-features-0-1-1","dir":"Changelog","previous_headings":"","what":"New features","title":"teal.reporter 0.1.1","text":"Added Archiver class enables saving loading back Report shiny session.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"breaking-changes-0-1-1","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"teal.reporter 0.1.1","text":"Updated append_fs method TealReportCard accept list object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"enhancements-0-1-1","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"teal.reporter 0.1.1","text":"Added support ElementaryTree class append_table method ReportCard. Added additional validation card_fun evaluation. Added support arguments setup card_fun function add_card_button_srv module, card_fun subset possible arguments now. Added optional dim argument append_plot method ReportCard. Added support Heatmap plots PictureBlock. Updated append_encodings, append_src append_fs automatically add titles. Updated vignettes README content. Made document type names user friendly downloading report. Improved add reporter card button disabled clicked.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"bug-fixes-0-1-1","dir":"Changelog","previous_headings":"","what":"Bug fixes","title":"teal.reporter 0.1.1","text":"Fixed trellis plots catched set_content method PictureBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"miscellaneous-0-1-1","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.1.1","text":"Added to_list from_list methods content related classes. Decoupled metadata content ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/news/index.html","id":"tealreporter-010","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.1.0","title":"teal.reporter 0.1.0","text":"Initialize package.","code":""}] +[{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contribution Guidelines","title":"Contribution Guidelines","text":"🙏 Thank taking time contribute! input deeply valued, whether issue, pull request, even feedback, regardless size, content scope.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contribution Guidelines","text":"👶 Getting started 📔 Code Conduct 🗃 License 📜 Issues 🚩 Pull requests 💻 Coding guidelines 🏆 Recognition model ❓ Questions","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Contribution Guidelines","text":"Please refer project documentation brief introduction. Please also see articles within project documentation additional information.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contribution Guidelines","text":"Code Conduct governs project. Participants contributors expected follow rules outlined therein.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Contribution Guidelines","text":"contributions covered project’s license.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"issues","dir":"","previous_headings":"","what":"Issues","title":"Contribution Guidelines","text":"use GitHub track issues, feature requests, bugs. submitting new issue, please check issue already reported. issue already exists, please upvote existing issue 👍. new feature requests, please elaborate context benefit feature users, developers, relevant personas.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"github-flow","dir":"","previous_headings":"Pull requests","what":"GitHub Flow","title":"Contribution Guidelines","text":"repository uses GitHub Flow model collaboration. submit pull request: Create branch Please see branch naming convention . don’t write access repository, please fork . Make changes Make sure code passes checks imposed GitHub Actions well documented well tested unit tests sufficiently covering changes introduced Create pull request (PR) pull request description, please link relevant issue (), provide detailed description change, include assumptions. Address review comments, Post approval Merge PR write access. Otherwise, reviewer merge PR behalf. Pat back Congratulations! 🎉 now official contributor project! grateful contribution.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"branch-naming-convention","dir":"","previous_headings":"Pull requests","what":"Branch naming convention","title":"Contribution Guidelines","text":"Suppose changes related current issue current project; please name branch follows: _. Please use underscore (_) delimiter word separation. example, 420_fix_ui_bug suitable branch name change resolving UI-related bug reported issue number 420 current project. change affects multiple repositories, please name branches follows: __. example, 69_awesomeproject_fix_spelling_error reference issue 69 reported project awesomeproject aims resolve one spelling errors multiple (likely related) repositories.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"monorepo-and-stageddependencies","dir":"","previous_headings":"Pull requests","what":"monorepo and staged.dependencies","title":"Contribution Guidelines","text":"Sometimes might need change upstream dependent package(s) able submit meaningful change. using staged.dependencies functionality simulate monorepo behavior. dependency configuration already specified project’s staged_dependencies.yaml file. need name feature branches appropriately. exception branch naming convention described . Please refer staged.dependencies package documentation details.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"coding-guidelines","dir":"","previous_headings":"","what":"Coding guidelines","title":"Contribution Guidelines","text":"repository follows unified processes standards adopted maintainers ensure software development carried consistently within teams cohesively across repositories.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"Coding guidelines","what":"Style guide","title":"Contribution Guidelines","text":"repository follows standard tidyverse style guide uses lintr lint checks. Customized lint configurations available repository’s .lintr file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"dependency-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency management","title":"Contribution Guidelines","text":"Lightweight right weight. repository follows tinyverse recommedations limiting dependencies minimum.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"dependency-version-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency version management","title":"Contribution Guidelines","text":"code compatible (!) historical versions given dependenct package, required specify minimal version DESCRIPTION file. particular: development version requires (imports) development version another package - required put abc (>= 1.2.3.9000).","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"r--package-versions","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"R & package versions","title":"Contribution Guidelines","text":"continuously test packages newest R version along recent dependencies CRAN BioConductor. recommend working environment also set way. can find details R version packages used R CMD check GitHub Action execution log - step prints R sessionInfo(). discover bugs older R versions older set dependencies, please create relevant bug reports.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"pre-commit","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"pre-commit","title":"Contribution Guidelines","text":"highly recommend use pre-commit tool combined R hooks pre-commit execute checks committing pushing changes. Pre-commit hooks already available repository’s .pre-commit-config.yaml file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"recognition-model","dir":"","previous_headings":"","what":"Recognition model","title":"Contribution Guidelines","text":"mentioned previously, contributions deeply valued appreciated. contribution data available part repository insights, recognize significant contribution hence add contributor package authors list, following rules enforced: Minimum 5% lines code authored* (determined git blame query) top 5 contributors terms number commits lines added lines removed* *Excluding auto-generated code, including limited roxygen comments renv.lock files. package maintainer also reserves right adjust criteria recognize contributions.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/CONTRIBUTING.html","id":"questions","dir":"","previous_headings":"","what":"Questions","title":"Contribution Guidelines","text":"questions regarding contribution guidelines, please contact package/repository maintainer.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/SECURITY.html","id":"reporting-security-issues","dir":"","previous_headings":"","what":"Reporting Security Issues","title":"Security Policy","text":"believe found security vulnerability repositories organization, please report us coordinated disclosure. Please report security vulnerabilities public GitHub issues, discussions, pull requests. Instead, please send email vulnerability.management[@]roche.com. Please include much information listed can help us better understand resolve issue: type issue (e.g., buffer overflow, SQL injection, cross-site scripting) Full paths source file(s) related manifestation issue location affected source code (tag/branch/commit direct URL) special configuration required reproduce issue Step--step instructions reproduce issue Proof--concept exploit code (possible) Impact issue, including attacker might exploit issue information help us triage report quickly.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/SECURITY.html","id":"data-security-standards-dss","dir":"","previous_headings":"","what":"Data Security Standards (DSS)","title":"Security Policy","text":"Please make sure reporting issues form bug, feature, pull request, sensitive information PII, PHI, PCI completely removed text attachments, including pictures videos.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/articles/teal-reporter.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Getting Started with teal.reporter","text":"times explore data shiny module, spot interesting finding capture , slides presentation, markdown article another medium. teal.reporter helps enhance shiny module users copy-paste save every finding write markdown show . teal.reporter gives ready use shiny modules objects work together prepare reports module minimal input users shiny modules developer. can done easy adding one reporting tools module:","code":"library(teal.reporter) ## ui <- shiny::fluidPage(simple_reporter_ui(\"simple\")) server <- function(input, output, session) { # The bulk of your module logic here create_module_card <- function(card) { card$append_text(\"This is the content of the report from the `simple` module\") } simple_reporter_srv(\"simple\", Reporter$new(), create_module_card) } if (interactive()) shiny::shinyApp(ui, server)"},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/articles/teal-reporter.html","id":"basic-usage","dir":"Articles","previous_headings":"Where to next","what":"Basic usage","title":"Getting Started with teal.reporter","text":"basic usage teal.reporter quickest way enhance modules reporting, head vignette simple reporting setup.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/articles/teal-reporter.html","id":"previewing-a-report","dir":"Articles","previous_headings":"Where to next","what":"Previewing a report","title":"Getting Started with teal.reporter","text":"want let users application preview report reorganize , look vignette “report previewer” module.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/articles/teal-reporter.html","id":"integration-with-teal","dir":"Articles","previous_headings":"Where to next","what":"Integration with teal","title":"Getting Started with teal.reporter","text":"interested teal.reporter fits teal, look vignette teal.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/articles/teal-reporter.html","id":"more-control","dir":"Articles","previous_headings":"Where to next","what":"More control","title":"Getting Started with teal.reporter","text":"like control layout simple reporting tool, recommend reading documentation smallest building blocks teal.reporter offers, add_card_button_srv(), download_report_button_srv() reset_report_button_srv().","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Dawid Kaledkowski. Maintainer. Maciej Nasinski. Author. Konrad Pagacz. Author. Mahmoud mahmoud.hallal@roche.com Hallal. Author. F. Hoffmann-La Roche AG. Copyright holder, funder.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Nasinski M, Pagacz K, Hallal Mm (2024). teal.reporter: Reporting Tools 'shiny' Modules. R package version 0.2.1.9015, https://insightsengineering.github.io/teal.reporter/main/, https://github.com/insightsengineering/teal.reporter.","code":"@Manual{, title = {teal.reporter: Reporting Tools for 'shiny' Modules}, author = {Maciej Nasinski and Konrad Pagacz and Mahmoud mahmoud.hallal@roche.com Hallal}, year = {2024}, note = {R package version 0.2.1.9015, https://insightsengineering.github.io/teal.reporter/main/}, url = {https://github.com/insightsengineering/teal.reporter}, }"},{"path":"https://insightsengineering.github.io/teal.reporter/main/index.html","id":"tealreporter","dir":"","previous_headings":"","what":"Reporting Tools for shiny Modules","title":"Reporting Tools for shiny Modules","text":"teal.reporter empowers shiny teal applications seamlessly integrate reporting functionality. Developers, whether working shiny app teal module, define report’s content, teal.reporter takes care rest. package provides: shiny module adding cards (.e. items) report shiny module previewing report -screen ability download zip file containing reports","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Reporting Tools for shiny Modules","text":"Alternatively, might want use development version available r-universe.","code":"# stable versions install.packages('teal.reporter') # install.packages(\"pak\") pak::pak(\"insightsengineering/teal.reporter@*release\") # beta versions install.packages('teal.reporter', repos = c('https://pharmaverse.r-universe.dev', getOption('repos'))) # install.packages(\"pak\") pak::pak(\"insightsengineering/teal.reporter\")"},{"path":"https://insightsengineering.github.io/teal.reporter/main/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Reporting Tools for shiny Modules","text":"understand use package, please refer Getting Started article, provides multiple examples code implementation.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/index.html","id":"getting-help","dir":"","previous_headings":"","what":"Getting help","title":"Reporting Tools for shiny Modules","text":"encounter bug feature request - please file issue. questions, discussions staying date, please use “teal” channel pharmaverse slack workspace.","code":""},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/pull_request_template.html","id":null,"dir":"","previous_headings":"","what":"Pull Request","title":"Pull Request","text":"Fixes #nnn","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":null,"dir":"Reference","previous_headings":"","what":"Archiver — Archiver","title":"Archiver — Archiver","text":"Archiver Archiver","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Archiver — Archiver","text":"Archiver$new() Archiver$finalize() Archiver$read() Archiver$write() Archiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Archiver — Archiver","text":"Returns Archiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Archiver — Archiver","text":"Archiver object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Archiver — Archiver","text":"","code":"Archiver <- getFromNamespace(\"Archiver\", \"teal.reporter\") Archiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"Archiver — Archiver","text":"Finalizes Archiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"method-read-","dir":"Reference","previous_headings":"","what":"Method read()","title":"Archiver — Archiver","text":"Pure virtual method reading Archiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$read()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"method-write-","dir":"Reference","previous_headings":"","what":"Method write()","title":"Archiver — Archiver","text":"Pure virtual method writing Archiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$write()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Archiver — Archiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Archiver — Archiver","text":"","code":"Archiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Archiver — Archiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Archiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Archiver — Archiver","text":"","code":"## ------------------------------------------------ ## Method `Archiver$new` ## ------------------------------------------------ Archiver <- getFromNamespace(\"Archiver\", \"teal.reporter\") Archiver$new() #> #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> initialize: function () #> read: function () #> write: function ()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"ContentBlock — ContentBlock","title":"ContentBlock — ContentBlock","text":"ContentBlock ContentBlock","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ContentBlock — ContentBlock","text":"ContentBlock$new() ContentBlock$set_content() ContentBlock$get_content() ContentBlock$from_list() ContentBlock$to_list() ContentBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ContentBlock — ContentBlock","text":"Returns ContentBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"ContentBlock — ContentBlock","text":"Returns ContentBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") ContentBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-set-content-","dir":"Reference","previous_headings":"","what":"Method set_content()","title":"ContentBlock — ContentBlock","text":"Sets content ContentBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$set_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"content (character(0) character(1)) string literal file path assigned ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$set_content(\"Base64 encoded picture\")"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"ContentBlock — ContentBlock","text":"Returns absolute path content ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"character content ContentBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"ContentBlock — ContentBlock","text":"Create ContentBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"x named list two fields c(\"text\", \"style\"). Use get_available_styles method get possible styles.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"ContentBlock — ContentBlock","text":"Convert ContentBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"ContentBlock — ContentBlock","text":"named list text style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ContentBlock — ContentBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentBlock — ContentBlock","text":"","code":"ContentBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentBlock — ContentBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ContentBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ContentBlock — ContentBlock","text":"","code":"## ------------------------------------------------ ## Method `ContentBlock$new` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") ContentBlock$new() #> #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_content: function () #> initialize: function () #> set_content: function (content) #> to_list: function () #> Private: #> content: #> deep_clone: function (name, value) ## ------------------------------------------------ ## Method `ContentBlock$set_content` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$set_content(\"Base64 encoded picture\") ## ------------------------------------------------ ## Method `ContentBlock$get_content` ## ------------------------------------------------ ContentBlock <- getFromNamespace(\"ContentBlock\", \"teal.reporter\") block <- ContentBlock$new() block$get_content() #> character(0)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":null,"dir":"Reference","previous_headings":"","what":"RDSArchiver — FileArchiver","title":"RDSArchiver — FileArchiver","text":"RDSArchiver RDSArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"RDSArchiver — FileArchiver","text":"teal.reporter::Archiver -> FileArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"RDSArchiver — FileArchiver","text":"teal.reporter::Archiver$read() teal.reporter::Archiver$write()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"RDSArchiver — FileArchiver","text":"FileArchiver$new() FileArchiver$finalize() FileArchiver$get_output_dir() FileArchiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"RDSArchiver — FileArchiver","text":"Returns FileArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"RDSArchiver — FileArchiver","text":"FileArchiver object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"RDSArchiver — FileArchiver","text":"Finalizes FileArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"method-get-output-dir-","dir":"Reference","previous_headings":"","what":"Method get_output_dir()","title":"RDSArchiver — FileArchiver","text":"get output_dir field","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"RDSArchiver — FileArchiver","text":"character output_dir field path.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"RDSArchiver — FileArchiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"RDSArchiver — FileArchiver","text":"","code":"FileArchiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"RDSArchiver — FileArchiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileArchiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RDSArchiver — FileArchiver","text":"","code":"## ------------------------------------------------ ## Method `FileArchiver$new` ## ------------------------------------------------ FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new() #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function () #> write: function () #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534439211 ## ------------------------------------------------ ## Method `FileArchiver$get_output_dir` ## ------------------------------------------------ FileArchiver <- getFromNamespace(\"FileArchiver\", \"teal.reporter\") FileArchiver$new()$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534439360\""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"FileBlock — FileBlock","title":"FileBlock — FileBlock","text":"FileBlock FileBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"FileBlock — FileBlock","text":"teal.reporter::ContentBlock -> FileBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"FileBlock — FileBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$initialize() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"FileBlock — FileBlock","text":"FileBlock$finalize() FileBlock$from_list() FileBlock$to_list() FileBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"FileBlock — FileBlock","text":"finalize FileBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"FileBlock — FileBlock","text":"Removes temporary file created constructor.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"FileBlock — FileBlock","text":"Create FileBlock list. list contain one named field, \"basename\".","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$from_list(x, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"x named list one field \"basename\", name file. output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"FileBlock — FileBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() file_path <- tempfile(fileext = \".png\") saveRDS(iris, file_path) block$from_list(list(basename = basename(file_path)), dirname(file_path))"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"FileBlock — FileBlock","text":"Convert FileBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"FileBlock — FileBlock","text":"named list basename file.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() block$to_list(tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"FileBlock — FileBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"FileBlock — FileBlock","text":"","code":"FileBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"FileBlock — FileBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/FileBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"FileBlock — FileBlock","text":"","code":"## ------------------------------------------------ ## Method `FileBlock$from_list` ## ------------------------------------------------ FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() file_path <- tempfile(fileext = \".png\") saveRDS(iris, file_path) block$from_list(list(basename = basename(file_path)), dirname(file_path)) ## ------------------------------------------------ ## Method `FileBlock$to_list` ## ------------------------------------------------ FileBlock <- getFromNamespace(\"FileBlock\", \"teal.reporter\") block <- FileBlock$new() block$to_list(tempdir()) #> $basename #> character(0) #>"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":null,"dir":"Reference","previous_headings":"","what":"JSONArchiver — JSONArchiver","title":"JSONArchiver — JSONArchiver","text":"JSONArchiver JSONArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"JSONArchiver — JSONArchiver","text":"teal.reporter::Archiver -> teal.reporter::FileArchiver -> JSONArchiver","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"JSONArchiver — JSONArchiver","text":"teal.reporter::FileArchiver$finalize() teal.reporter::FileArchiver$get_output_dir() teal.reporter::FileArchiver$initialize()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"JSONArchiver — JSONArchiver","text":"JSONArchiver$write() JSONArchiver$read() JSONArchiver$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"method-write-","dir":"Reference","previous_headings":"","what":"Method write()","title":"JSONArchiver — JSONArchiver","text":"write Reporter instance JSONArchiver object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$write(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"JSONArchiver — JSONArchiver","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) archiver$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"method-read-","dir":"Reference","previous_headings":"","what":"Method read()","title":"JSONArchiver — JSONArchiver","text":"read Reporter instance directory JSONArchiver.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$read(path = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"path character(1) path directory proper files.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"JSONArchiver — JSONArchiver","text":"Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) archiver$get_output_dir() archiver$read()$get_cards()[[1]]$get_content() Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") blocks <- Reporter$new() blocks <- blocks$from_reporter(archiver$read())$get_blocks() Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") doc <- Renderer$new()$render(blocks)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"JSONArchiver — JSONArchiver","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"JSONArchiver — JSONArchiver","text":"","code":"JSONArchiver$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"JSONArchiver — JSONArchiver","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/JSONArchiver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"JSONArchiver — JSONArchiver","text":"","code":"## ------------------------------------------------ ## Method `JSONArchiver$write` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function (path = NULL) #> write: function (reporter) #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534447062 archiver$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534447062\" ## ------------------------------------------------ ## Method `JSONArchiver$read` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1)) JSONArchiver <- getFromNamespace(\"JSONArchiver\", \"teal.reporter\") archiver <- JSONArchiver$new() archiver$write(reporter) #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> read: function (path = NULL) #> write: function (reporter) #> Private: #> output_dir: /tmp/RtmpaeuLcj/archive_202401231534448535 archiver$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/archive_202401231534448535\" archiver$read()$get_cards()[[1]]$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf63da3e56.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") blocks <- Reporter$new() blocks <- blocks$from_reporter(archiver$read())$get_blocks() Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") doc <- Renderer$new()$render(blocks)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"NewpageBlock — NewpageBlock","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"NewpageBlock — NewpageBlock","text":"teal.reporter::ContentBlock -> NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"NewpageBlock — NewpageBlock","text":"teal.reporter::ContentBlock$from_list() teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content() teal.reporter::ContentBlock$to_list()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock$new() NewpageBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"NewpageBlock — NewpageBlock","text":"Returns NewpageBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"NewpageBlock — NewpageBlock","text":"Returns NewpageBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"NewpageBlock — NewpageBlock","text":"NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") block <- NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"NewpageBlock — NewpageBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"NewpageBlock — NewpageBlock","text":"","code":"NewpageBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"NewpageBlock — NewpageBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/NewpageBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"NewpageBlock — NewpageBlock","text":"","code":"## ------------------------------------------------ ## Method `NewpageBlock$new` ## ------------------------------------------------ NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") block <- NewpageBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"RcodeBlock — RcodeBlock","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"RcodeBlock — RcodeBlock","text":"teal.reporter::ContentBlock -> RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"RcodeBlock — RcodeBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock$new() RcodeBlock$set_params() RcodeBlock$get_params() RcodeBlock$get_available_params() RcodeBlock$from_list() RcodeBlock$to_list() RcodeBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"RcodeBlock — RcodeBlock","text":"Returns RcodeBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$new(content = character(0), ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"content (character(1) character(0)) string assigned RcodeBlock ... rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"RcodeBlock — RcodeBlock","text":"Returns RcodeBlock object content parameters.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-set-params-","dir":"Reference","previous_headings":"","what":"Method set_params()","title":"RcodeBlock — RcodeBlock","text":"Sets parameters RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$set_params(params)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"params (list) rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"RcodeBlock — RcodeBlock","text":"parameters bearing rendering block.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$set_params(list(echo = TRUE))"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-get-params-","dir":"Reference","previous_headings":"","what":"Method get_params()","title":"RcodeBlock — RcodeBlock","text":"Returns parameters RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$get_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"character parameters RcodeBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-get-available-params-","dir":"Reference","previous_headings":"","what":"Method get_available_params()","title":"RcodeBlock — RcodeBlock","text":"Returns array parameters available RcodeBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$get_available_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"character array parameters","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_available_params()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"RcodeBlock — RcodeBlock","text":"Create RcodeBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"x named list two fields c(\"text\", \"params\"). Use get_available_params method get possible parameters.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$from_list(list(text = \"sth\", params = list()))"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"RcodeBlock — RcodeBlock","text":"Convert RcodeBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"RcodeBlock — RcodeBlock","text":"named list text params.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"RcodeBlock — RcodeBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"RcodeBlock — RcodeBlock","text":"","code":"RcodeBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"RcodeBlock — RcodeBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/RcodeBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"RcodeBlock — RcodeBlock","text":"","code":"## ------------------------------------------------ ## Method `RcodeBlock$new` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() ## ------------------------------------------------ ## Method `RcodeBlock$set_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$set_params(list(echo = TRUE)) ## ------------------------------------------------ ## Method `RcodeBlock$get_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_params() #> list() ## ------------------------------------------------ ## Method `RcodeBlock$get_available_params` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$get_available_params() #> [1] \"eval\" \"echo\" \"results\" \"tidy\" #> [5] \"tidy.opts\" \"collapse\" \"prompt\" \"comment\" #> [9] \"highlight\" \"size\" \"background\" \"strip.white\" #> [13] \"cache\" \"cache.path\" \"cache.vars\" \"cache.lazy\" #> [17] \"dependson\" \"autodep\" \"cache.rebuild\" \"fig.keep\" #> [21] \"fig.show\" \"fig.align\" \"fig.path\" \"dev\" #> [25] \"dev.args\" \"dpi\" \"fig.ext\" \"fig.width\" #> [29] \"fig.height\" \"fig.env\" \"fig.cap\" \"fig.scap\" #> [33] \"fig.lp\" \"fig.subcap\" \"fig.pos\" \"out.width\" #> [37] \"out.height\" \"out.extra\" \"fig.retina\" \"external\" #> [41] \"sanitize\" \"interval\" \"aniopts\" \"warning\" #> [45] \"error\" \"message\" \"render\" \"ref.label\" #> [49] \"child\" \"engine\" \"split\" \"include\" #> [53] \"purl\" ## ------------------------------------------------ ## Method `RcodeBlock$from_list` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$from_list(list(text = \"sth\", params = list())) ## ------------------------------------------------ ## Method `RcodeBlock$to_list` ## ------------------------------------------------ RcodeBlock <- getFromNamespace(\"RcodeBlock\", \"teal.reporter\") block <- RcodeBlock$new() block$to_list() #> $text #> character(0) #> #> $params #> list() #>"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":null,"dir":"Reference","previous_headings":"","what":"Renderer — Renderer","title":"Renderer — Renderer","text":"Renderer Renderer","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Renderer — Renderer","text":"Renderer$new() Renderer$finalize() Renderer$renderRmd() Renderer$render() Renderer$get_output_dir() Renderer$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Renderer — Renderer","text":"Returns Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"Returns Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") Renderer$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-finalize-","dir":"Reference","previous_headings":"","what":"Method finalize()","title":"Renderer — Renderer","text":"Finalizes Renderer object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$finalize()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-renderrmd-","dir":"Reference","previous_headings":"","what":"Method renderRmd()","title":"Renderer — Renderer","text":"getting Rmd text easily rendered later.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$renderRmd( blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\") )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"blocks list c(\"TextBlock\", \"PictureBlock\", \"NewpageBlock\") objects. yaml_header character rmarkdown yaml header. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character Rmd text (yaml header + body), ready rendered.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$renderRmd(reporter$get_blocks(), yaml_header)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-render-","dir":"Reference","previous_headings":"","what":"Method render()","title":"Renderer — Renderer","text":"Renders content Report output file","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$render( blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\"), ... )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"blocks list c(\"TextBlock\", \"PictureBlock\", \"NewpageBlock\") objects. yaml_header character rmarkdown yaml header. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. ... rmarkdown::render arguments, input output_dir updated.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"details-2","dir":"Reference","previous_headings":"","what":"Details","title":"Renderer — Renderer","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character path output","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\")$new() Reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$render(Reporter$get_blocks(), yaml_header)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-get-output-dir-","dir":"Reference","previous_headings":"","what":"Method get_output_dir()","title":"Renderer — Renderer","text":"get output_dir field","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Renderer — Renderer","text":"character output_dir field path.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\")$new() Renderer$get_output_dir()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Renderer — Renderer","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Renderer — Renderer","text":"","code":"Renderer$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Renderer — Renderer","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Renderer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Renderer — Renderer","text":"","code":"## ------------------------------------------------ ## Method `Renderer$new` ## ------------------------------------------------ Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") Renderer$new() #> #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> get_output_dir: function () #> initialize: function () #> render: function (blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\"), #> renderRmd: function (blocks, yaml_header, global_knitr = getOption(\"teal.reporter.global_knitr\")) #> Private: #> block2md: function (block) #> output_dir: /tmp/RtmpaeuLcj/report_202401231534462941 #> pictureBlock2md: function (block) #> rcodeBlock2md: function (block) #> report_type: NULL #> tableBlock2md: function (block) #> textBlock2md: function (block) ## ------------------------------------------------ ## Method `Renderer$renderRmd` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\") reporter <- Reporter$new() reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$renderRmd(reporter$get_blocks(), yaml_header) ## ------------------------------------------------ ## Method `Renderer$render` ## ------------------------------------------------ ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card1 <- ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ReportCard <- getFromNamespace(\"ReportCard\", \"teal.reporter\") card2 <- ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) card2$append_rcode(\"2+2\", echo = FALSE) Reporter <- getFromNamespace(\"Reporter\", \"teal.reporter\")$new() Reporter$append_cards(list(card1, card2)) yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml_l <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(html_document = list(toc = FALSE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") yaml_header <- md_header(yaml::as.yaml(yaml_l)) Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\") result_path <- Renderer$new()$render(Reporter$get_blocks(), yaml_header) ## ------------------------------------------------ ## Method `Renderer$get_output_dir` ## ------------------------------------------------ Renderer <- getFromNamespace(\"Renderer\", \"teal.reporter\")$new() Renderer$get_output_dir() #> [1] \"/tmp/RtmpaeuLcj/report_202401231534494419\""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":null,"dir":"Reference","previous_headings":"","what":"ReportCard — ReportCard","title":"ReportCard — ReportCard","text":"R6 class supports creating report card containing text, plot, table meta data blocks can appended rendered form report output shiny app.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ReportCard — ReportCard","text":"ReportCard$new() ReportCard$append_table() ReportCard$append_plot() ReportCard$append_text() ReportCard$append_rcode() ReportCard$append_content() ReportCard$get_content() ReportCard$reset() ReportCard$get_metadata() ReportCard$append_metadata() ReportCard$get_name() ReportCard$set_name() ReportCard$to_list() ReportCard$from_list() ReportCard$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ReportCard — ReportCard","text":"Returns ReportCard object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"ReportCard object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-table-","dir":"Reference","previous_headings":"","what":"Method append_table()","title":"ReportCard — ReportCard","text":"Appends table ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_table(table)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"table appended table","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_table(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-plot-","dir":"Reference","previous_headings":"","what":"Method append_plot()","title":"ReportCard — ReportCard","text":"Appends plot ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_plot(plot, dim = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"plot appended plot dim integer vector width height pixels.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-text-","dir":"Reference","previous_headings":"","what":"Method append_text()","title":"ReportCard — ReportCard","text":"Appends paragraph text ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_text(text, style = TextBlock$new()$get_available_styles()[1])"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"text (character(0) character(1)) text style (character(1)) style paragraph. One : default, header, verbatim","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"A paragraph of default text\")"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-rcode-","dir":"Reference","previous_headings":"","what":"Method append_rcode()","title":"ReportCard — ReportCard","text":"Appends rmarkdown R chunk ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_rcode(text, ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"text (character(0) character(1)) text ... rmarkdown R chunk parameter value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_rcode(\"2+2\", echo = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-content-","dir":"Reference","previous_headings":"","what":"Method append_content()","title":"ReportCard — ReportCard","text":"Appends ContentBlock ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"content (ContentBlock)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") card <- ReportCard$new()$append_content(NewpageBlock$new())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"ReportCard — ReportCard","text":"Returns content ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"list() list TableBlock, TextBlock PictureBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-6","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_content()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"ReportCard — ReportCard","text":"Removes objects added ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$reset()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"ReportCard — ReportCard","text":"Returns metadata ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"named list list elements.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-7","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-append-metadata-","dir":"Reference","previous_headings":"","what":"Method append_metadata()","title":"ReportCard — ReportCard","text":"Appends metadata ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$append_metadata(key, value)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"key (character(1)) name meta data. value value meta data.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-8","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() card$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-get-name-","dir":"Reference","previous_headings":"","what":"Method get_name()","title":"ReportCard — ReportCard","text":"get Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"character Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-9","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()$set_name(\"NAME\")$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-set-name-","dir":"Reference","previous_headings":"","what":"Method set_name()","title":"ReportCard — ReportCard","text":"set Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$set_name(name)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"name character Card name","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-10","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"ReportCard$new()$set_name(\"NAME\")$get_name()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"ReportCard — ReportCard","text":"Convert ReportCard list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"output_dir character path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"named list ReportCard representation.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-11","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() card$to_list(tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"ReportCard — ReportCard","text":"Create ReportCard list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$from_list(card, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"card named list ReportCard representation. output_dir character path directory file copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"ReportCard — ReportCard","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"examples-12","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) card$get_content() ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ReportCard — ReportCard","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"ReportCard — ReportCard","text":"","code":"ReportCard$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"ReportCard — ReportCard","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/ReportCard.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ReportCard — ReportCard","text":"","code":"## ------------------------------------------------ ## Method `ReportCard$new` ## ------------------------------------------------ card <- ReportCard$new() ## ------------------------------------------------ ## Method `ReportCard$append_table` ## ------------------------------------------------ card <- ReportCard$new()$append_table(iris) ## ------------------------------------------------ ## Method `ReportCard$append_plot` ## ------------------------------------------------ card <- ReportCard$new()$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. ## ------------------------------------------------ ## Method `ReportCard$append_text` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"A paragraph of default text\") ## ------------------------------------------------ ## Method `ReportCard$append_rcode` ## ------------------------------------------------ card <- ReportCard$new()$append_rcode(\"2+2\", echo = FALSE) ## ------------------------------------------------ ## Method `ReportCard$append_content` ## ------------------------------------------------ NewpageBlock <- getFromNamespace(\"NewpageBlock\", \"teal.reporter\") card <- ReportCard$new()$append_content(NewpageBlock$new()) ## ------------------------------------------------ ## Method `ReportCard$get_content` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> ## ------------------------------------------------ ## Method `ReportCard$get_metadata` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_metadata(\"rc\", \"a <- 2 + 2\") card$get_metadata() #> $rc #> [1] \"a <- 2 + 2\" #> ## ------------------------------------------------ ## Method `ReportCard$append_metadata` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf86a4dab.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> card$get_metadata() #> $lm #> #> Call: #> lm(formula = Ozone ~ Solar.R, data = airquality) #> #> Coefficients: #> (Intercept) Solar.R #> 18.5987 0.1272 #> #> ## ------------------------------------------------ ## Method `ReportCard$get_name` ## ------------------------------------------------ ReportCard$new()$set_name(\"NAME\")$get_name() #> [1] \"NAME\" ## ------------------------------------------------ ## Method `ReportCard$set_name` ## ------------------------------------------------ ReportCard$new()$set_name(\"NAME\")$get_name() #> [1] \"NAME\" ## ------------------------------------------------ ## Method `ReportCard$to_list` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf131a5dc6.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> card$to_list(tempdir()) #> $blocks #> $blocks$TextBlock #> $blocks$TextBlock$text #> [1] \"Some text\" #> #> $blocks$TextBlock$style #> [1] \"default\" #> #> #> $blocks$PictureBlock #> $blocks$PictureBlock$basename #> [1] \"file1bf131a5dc6.png\" #> #> #> $blocks$TextBlock #> $blocks$TextBlock$text #> [1] \"Some text\" #> #> $blocks$TextBlock$style #> [1] \"default\" #> #> #> #> $metadata #> $metadata$lm #> #> Call: #> lm(formula = Ozone ~ Solar.R, data = airquality) #> #> Coefficients: #> (Intercept) Solar.R #> 18.5987 0.1272 #> #> #> ## ------------------------------------------------ ## Method `ReportCard$from_list` ## ------------------------------------------------ card <- ReportCard$new()$append_text(\"Some text\")$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() )$append_text(\"Some text\")$append_metadata(key = \"lm\", value = lm(Ozone ~ Solar.R, airquality)) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card$get_content() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf650dadd2.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Some text #> deep_clone: function (name, value) #> style: default #> styles: default header2 header3 verbatim #> ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter — Reporter","title":"Reporter — Reporter","text":"R6 class stores manages report cards.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Reporter — Reporter","text":"function used shiny reactive context.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Reporter — Reporter","text":"Reporter$new() Reporter$append_cards() Reporter$get_cards() Reporter$get_blocks() Reporter$reset() Reporter$remove_cards() Reporter$swap_cards() Reporter$get_reactive_add_card() Reporter$get_metadata() Reporter$append_metadata() Reporter$from_reporter() Reporter$to_list() Reporter$from_list() Reporter$to_jsondir() Reporter$from_jsondir() Reporter$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Reporter — Reporter","text":"Returns Reporter object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"Reporter object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- teal.reporter::Reporter$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-append-cards-","dir":"Reference","previous_headings":"","what":"Method append_cards()","title":"Reporter — Reporter","text":"Appends table Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$append_cards(cards)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"cards ReportCard list objects","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2))"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-get-cards-","dir":"Reference","previous_headings":"","what":"Method get_cards()","title":"Reporter — Reporter","text":"Returns cards Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_cards()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"list() list ReportCard","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_cards()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-get-blocks-","dir":"Reference","previous_headings":"","what":"Method get_blocks()","title":"Reporter — Reporter","text":"Returns blocks ReportCard Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_blocks(sep = NewpageBlock$new())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"sep element inserted content element Reporter. Pass NULL return content without additional elements. Default: NewpageBlock$new()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"list() list TableBlock, TextBlock, PictureBlock NewpageBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_blocks()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"Reporter — Reporter","text":"Removes ReportCard objects added Reporter. Additionally metadata removed.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$reset()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-remove-cards-","dir":"Reference","previous_headings":"","what":"Method remove_cards()","title":"Reporter — Reporter","text":"remove specific Card Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$remove_cards(ids = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"ids integer indexes cards","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-swap-cards-","dir":"Reference","previous_headings":"","what":"Method swap_cards()","title":"Reporter — Reporter","text":"swap two cards Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$swap_cards(start, end)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"start integer index first card end integer index second card","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-get-reactive-add-card-","dir":"Reference","previous_headings":"","what":"Method get_reactive_add_card()","title":"Reporter — Reporter","text":"get value reactive value add card","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_reactive_add_card()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"reactive_add_card field value","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"shiny::isolate(Reporter$new()$get_reactive_add_card())"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"Reporter — Reporter","text":"get metadata Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"metadata","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-append-metadata-","dir":"Reference","previous_headings":"","what":"Method append_metadata()","title":"Reporter — Reporter","text":"Appends metadata Reporter.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$append_metadata(meta)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"meta (list) metadata.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-6","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-from-reporter-","dir":"Reference","previous_headings":"","what":"Method from_reporter()","title":"Reporter — Reporter","text":"Create/Recreate Reporter another Reporter","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_reporter(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-7","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() reporter$from_reporter(reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"Reporter — Reporter","text":"Convert Reporter list transfer files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$to_list(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"named list Reporter representation","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-8","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") dir.create(tmp_dir) reporter$to_list(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"Reporter — Reporter","text":"Create/Recreate Reporter list directory files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_list(rlist, output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"rlist named list Reporter representation. output_dir character(1) path directory files copied.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-9","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") unlink(tmp_dir, recursive = TRUE) dir.create(tmp_dir) reporter$from_list(reporter$to_list(tmp_dir), tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-to-jsondir-","dir":"Reference","previous_headings":"","what":"Method to_jsondir()","title":"Reporter — Reporter","text":"Create/Recreate Reporter directory JSON file static files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$to_jsondir(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files copied, JSON statics.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-10","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) reporter$to_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-from-jsondir-","dir":"Reference","previous_headings":"","what":"Method from_jsondir()","title":"Reporter — Reporter","text":"Create/Recreate Reporter directory JSON file static files","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$from_jsondir(output_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"output_dir character(1) path directory files, JSON statics.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"returns-14","dir":"Reference","previous_headings":"","what":"Returns","title":"Reporter — Reporter","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"examples-11","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) unlink(list.files(tmp_dir, recursive = TRUE)) reporter$to_jsondir(tmp_dir) reporter$from_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Reporter — Reporter","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter — Reporter","text":"","code":"Reporter$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter — Reporter","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/Reporter.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reporter — Reporter","text":"","code":"## ------------------------------------------------ ## Method `Reporter$new` ## ------------------------------------------------ reporter <- teal.reporter::Reporter$new() ## ------------------------------------------------ ## Method `Reporter$append_cards` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) ## ------------------------------------------------ ## Method `Reporter$get_cards` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_cards() #> [[1]] #> #> Public: #> append_content: function (content) #> append_metadata: function (key, value) #> append_plot: function (plot, dim = NULL) #> append_rcode: function (text, ...) #> append_table: function (table) #> append_text: function (text, style = TextBlock$new()$get_available_styles()[1]) #> clone: function (deep = FALSE) #> from_list: function (card, output_dir) #> get_content: function () #> get_metadata: function () #> get_name: function () #> initialize: function () #> reset: function () #> set_name: function (name) #> to_list: function (output_dir) #> Private: #> content: list #> deep_clone: function (name, value) #> metadata: list #> name: #> #> [[2]] #> #> Public: #> append_content: function (content) #> append_metadata: function (key, value) #> append_plot: function (plot, dim = NULL) #> append_rcode: function (text, ...) #> append_table: function (table) #> append_text: function (text, style = TextBlock$new()$get_available_styles()[1]) #> clone: function (deep = FALSE) #> from_list: function (card, output_dir) #> get_content: function () #> get_metadata: function () #> get_name: function () #> initialize: function () #> reset: function () #> set_name: function (name) #> to_list: function (output_dir) #> Private: #> content: list #> deep_clone: function (name, value) #> metadata: list #> name: #> ## ------------------------------------------------ ## Method `Reporter$get_blocks` ## ------------------------------------------------ card1 <- teal.reporter::ReportCard$new() card1$append_text(\"Header 2 text\", \"header2\") card1$append_text(\"A paragraph of default text\", \"header2\") card1$append_plot( ggplot2::ggplot(iris, ggplot2::aes(x = Petal.Length)) + ggplot2::geom_histogram() ) #> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`. card2 <- teal.reporter::ReportCard$new() card2$append_text(\"Header 2 text\", \"header2\") card2$append_text(\"A paragraph of default text\", \"header2\") lyt <- rtables::analyze(rtables::split_rows_by(rtables::basic_table(), \"Day\"), \"Ozone\", afun = mean) table_res2 <- rtables::build_table(lyt, airquality) #> Split var [Day] was not character or factor. Converting to factor card2$append_table(table_res2) card2$append_table(iris) reporter <- teal.reporter::Reporter$new() reporter$append_cards(list(card1, card2)) reporter$get_blocks() #> [[1]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[2]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[3]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> get_dim: function () #> get_title: function () #> initialize: function (plot) #> set_content: function (content) #> set_dim: function (dim) #> set_title: function (title) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf7d4268e6.png #> deep_clone: function (name, value) #> dim: 800 600 #> supported_plots: ggplot grob trellis Heatmap #> title: #> type: #> #> [[4]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_content: function () #> initialize: function () #> set_content: function (content) #> to_list: function () #> Private: #> content: #> \\newpage #> #> deep_clone: function (name, value) #> #> [[5]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: Header 2 text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[6]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> from_list: function (x) #> get_available_styles: function () #> get_content: function () #> get_style: function () #> initialize: function (content = character(0), style = private$styles[1]) #> set_content: function (content) #> set_style: function (style) #> to_list: function () #> Private: #> content: A paragraph of default text #> deep_clone: function (name, value) #> style: header2 #> styles: default header2 header3 verbatim #> #> [[7]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> initialize: function (table) #> set_content: function (content) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf2c8af380.rds #> deep_clone: function (name, value) #> supported_tables: data.frame rtables TableTree ElementaryTable listing_df #> #> [[8]] #> #> Inherits from: #> Public: #> clone: function (deep = FALSE) #> finalize: function () #> from_list: function (x, output_dir) #> get_content: function () #> initialize: function (table) #> set_content: function (content) #> to_list: function (output_dir) #> Private: #> content: /tmp/RtmpaeuLcj/file1bf7c4e8b6a.rds #> deep_clone: function (name, value) #> supported_tables: data.frame rtables TableTree ElementaryTable listing_df #> ## ------------------------------------------------ ## Method `Reporter$get_reactive_add_card` ## ------------------------------------------------ shiny::isolate(Reporter$new()$get_reactive_add_card()) #> [1] 0 ## ------------------------------------------------ ## Method `Reporter$get_metadata` ## ------------------------------------------------ reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata() #> $sth #> [1] \"sth\" #> ## ------------------------------------------------ ## Method `Reporter$append_metadata` ## ------------------------------------------------ reporter <- Reporter$new()$append_metadata(list(sth = \"sth\")) reporter$get_metadata() #> $sth #> [1] \"sth\" #> ## ------------------------------------------------ ## Method `Reporter$from_reporter` ## ------------------------------------------------ reporter <- Reporter$new() reporter$from_reporter(reporter) ## ------------------------------------------------ ## Method `Reporter$to_list` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") dir.create(tmp_dir) reporter$to_list(tmp_dir) #> $version #> [1] \"1\" #> #> $cards #> list() #> #> $metadata #> list() #> ## ------------------------------------------------ ## Method `Reporter$from_list` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"testdir\") unlink(tmp_dir, recursive = TRUE) dir.create(tmp_dir) reporter$from_list(reporter$to_list(tmp_dir), tmp_dir) ## ------------------------------------------------ ## Method `Reporter$to_jsondir` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) reporter$to_jsondir(tmp_dir) #> [1] \"/tmp/RtmpaeuLcj/jsondir\" ## ------------------------------------------------ ## Method `Reporter$from_jsondir` ## ------------------------------------------------ reporter <- Reporter$new() tmp_dir <- file.path(tempdir(), \"jsondir\") dir.create(tmp_dir) #> Warning: '/tmp/RtmpaeuLcj/jsondir' already exists unlink(list.files(tmp_dir, recursive = TRUE)) reporter$to_jsondir(tmp_dir) #> [1] \"/tmp/RtmpaeuLcj/jsondir\" reporter$from_jsondir(tmp_dir)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"TableBlock — TableBlock","title":"TableBlock — TableBlock","text":"TableBlock TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"TableBlock — TableBlock","text":"teal.reporter::ContentBlock -> teal.reporter::FileBlock -> TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"TableBlock — TableBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::FileBlock$finalize() teal.reporter::FileBlock$from_list() teal.reporter::FileBlock$to_list()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"TableBlock — TableBlock","text":"TableBlock$new() TableBlock$set_content() TableBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"TableBlock — TableBlock","text":"Returns new TableBlock object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$new(table)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"table (data.frame, rtables, TableTree, ElementaryTable, listing_df) table assigned TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"TableBlock — TableBlock","text":"TableBlock object","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"method-set-content-","dir":"Reference","previous_headings":"","what":"Method set_content()","title":"TableBlock — TableBlock","text":"Sets content TableBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$set_content(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"content (data.frame, rtables, TableTree, ElementaryTable, listing_df) table assigned TableBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"TableBlock — TableBlock","text":"throws argument table-like object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"TableBlock — TableBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TableBlock — TableBlock","text":"","code":"TableBlock <- getFromNamespace(\"TableBlock\", \"teal.reporter\") block <- TableBlock$new() block$set_content(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"TableBlock — TableBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"TableBlock — TableBlock","text":"","code":"TableBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"TableBlock — TableBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TableBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TableBlock — TableBlock","text":"","code":"## ------------------------------------------------ ## Method `TableBlock$set_content` ## ------------------------------------------------ TableBlock <- getFromNamespace(\"TableBlock\", \"teal.reporter\") block <- TableBlock$new() block$set_content(iris)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":null,"dir":"Reference","previous_headings":"","what":"TextBlock — TextBlock","title":"TextBlock — TextBlock","text":"TextBlock TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"TextBlock — TextBlock","text":"teal.reporter::ContentBlock -> TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"TextBlock — TextBlock","text":"teal.reporter::ContentBlock$get_content() teal.reporter::ContentBlock$set_content()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"TextBlock — TextBlock","text":"TextBlock$new() TextBlock$set_style() TextBlock$get_style() TextBlock$get_available_styles() TextBlock$from_list() TextBlock$to_list() TextBlock$clone()","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"TextBlock — TextBlock","text":"Returns TextBlock object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$new(content = character(0), style = private$styles[1])"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"content (character(1) character(0)) string assigned TextBlock style (character(1)) one : \"default\", \"header2\", \"header3\" \"verbatim\"","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"TextBlock — TextBlock","text":"Returns TextBlock object content default style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-set-style-","dir":"Reference","previous_headings":"","what":"Method set_style()","title":"TextBlock — TextBlock","text":"Sets style TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$set_style(style)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"style (character(1)) one : \"default\", \"header2\", \"header3\" \"verbatim\"","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"details-1","dir":"Reference","previous_headings":"","what":"Details","title":"TextBlock — TextBlock","text":"style bearing rendering block.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples-1","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$set_style(\"header2\")"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-get-style-","dir":"Reference","previous_headings":"","what":"Method get_style()","title":"TextBlock — TextBlock","text":"Returns style TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$get_style()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"character(1) style TextBlock","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples-2","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_style()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-get-available-styles-","dir":"Reference","previous_headings":"","what":"Method get_available_styles()","title":"TextBlock — TextBlock","text":"Returns array styles available TextBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$get_available_styles()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"character array styles","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples-3","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_available_styles()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-from-list-","dir":"Reference","previous_headings":"","what":"Method from_list()","title":"TextBlock — TextBlock","text":"Create TextBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$from_list(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"x named list two fields c(\"text\", \"style\"). Use get_available_styles method get possible styles.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"invisibly self","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples-4","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$from_list(list(text = \"sth\", style = \"default\"))"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-to-list-","dir":"Reference","previous_headings":"","what":"Method to_list()","title":"TextBlock — TextBlock","text":"Convert TextBlock list.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"TextBlock — TextBlock","text":"named list text style.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"examples-5","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$to_list()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"TextBlock — TextBlock","text":"objects class cloneable method.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"TextBlock — TextBlock","text":"","code":"TextBlock$clone(deep = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"TextBlock — TextBlock","text":"deep Whether make deep clone.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/TextBlock.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"TextBlock — TextBlock","text":"","code":"## ------------------------------------------------ ## Method `TextBlock$new` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() ## ------------------------------------------------ ## Method `TextBlock$set_style` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$set_style(\"header2\") ## ------------------------------------------------ ## Method `TextBlock$get_style` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_style() #> [1] \"default\" ## ------------------------------------------------ ## Method `TextBlock$get_available_styles` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$get_available_styles() #> [1] \"default\" \"header2\" \"header3\" \"verbatim\" ## ------------------------------------------------ ## Method `TextBlock$from_list` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$from_list(list(text = \"sth\", style = \"default\")) ## ------------------------------------------------ ## Method `TextBlock$to_list` ## ------------------------------------------------ TextBlock <- getFromNamespace(\"TextBlock\", \"teal.reporter\") block <- TextBlock$new() block$to_list() #> $text #> character(0) #> #> $style #> [1] \"default\" #>"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Card Button Server — add_card_button_srv","title":"Add Card Button Server — add_card_button_srv","text":"server adding views/cards Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Card Button Server — add_card_button_srv","text":"","code":"add_card_button_srv(id, reporter, card_fun)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Card Button Server — add_card_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance. card_fun function returns ReportCard instance. can optional card, comment label parameters. card parameter added, ReportCard instance created user. Use comment parameter pass value whenever prefer card$append_text() - card_fun comment parameter, comment Add Card UI module added end content card. label parameter provided, can use customize appearance card name use specify card content card$append_text() - card_fun label parameter, card name set name passed Add Card UI module, text added content card.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Card Button Server — add_card_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Add Card Button Server — add_card_button_srv","text":"module allows using child ReportCard instead ReportCard. properly support , instance child class must passed default value card argument card_fun function. See :","code":"CustomReportCard <- R6::R6Class( # nolint: object_name_linter. classname = \"CustomReportCard\", inherit = teal.reporter::ReportCard ) custom_function <- function(card = CustomReportCard$new()) { card }"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Card Button User Interface — add_card_button_ui","title":"Add Card Button User Interface — add_card_button_ui","text":"button adding views/cards Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Card Button User Interface — add_card_button_ui","text":"","code":"add_card_button_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Card Button User Interface — add_card_button_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/add_card_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Card Button User Interface — add_card_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/as_yaml_auto.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"parse named list Rmd yaml header, developer gets automatically tabulated Rmd yaml header. non nested (flat) list processed, nested list directly processed yaml::.yaml function. Rmd yaml header fields vector supported, c(\"author\", \"date\", \"title\", \"subtitle\", \"abstract\", \"keywords\", \"subject\", \"description\", \"category\", \"lang\"). Moreover outputfield types rmarkdown package arguments supported.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/as_yaml_auto.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"","code":"as_yaml_auto( input_list, as_header = TRUE, convert_logi = TRUE, multi_output = FALSE, silent = FALSE )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/as_yaml_auto.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"input_list named list non nested slots names values compatible Rmd yaml header. as_header logical optionally wrap result internal md_header(), default TRUE. convert_logi logical convert character values logical, recognized quoted yaml logical values , default TRUE. multi_output logical multi output slots input argument, default FALSE. silent logical suppress messages warnings, default FALSE.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/as_yaml_auto.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"character rmd_yaml_header class, result yaml::.yaml, optionally wrapped internal md_header().","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/as_yaml_auto.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a Named List to the Rmd yaml Header — as_yaml_auto","text":"","code":"# nested so using yaml::as.yaml directly as_yaml_auto( list(author = \"\", output = list(pdf_document = list(toc = TRUE))) ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> --- # auto parsing for a flat list, like shiny input input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE) as_yaml_auto(input) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = \"TRUE\")) #> The 'TRUE' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list( author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE, wrong = 2 )) #> Warning: Not recognized and skipped arguments: wrong #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = 2), silent = TRUE ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: 2.0 #> --- input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = \"True\") as_yaml_auto(input) #> The 'True' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, convert_logi = TRUE, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- as_yaml_auto(input, convert_logi = FALSE, silent = TRUE) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: 'True' #> --- as_yaml_auto( list( author = \"\", output = \"pdf_document\", output = \"html_document\", toc = TRUE, keep_tex = TRUE ), multi_output = TRUE ) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> html_document: #> toc: yes #> --- as_yaml_auto( list( author = \"\", output = \"pdf_document\", output = \"html_document\", toc = \"True\", keep_tex = TRUE ), multi_output = TRUE ) #> The 'True' value should be a logical, so it is automatically converted. #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> html_document: #> toc: yes #> ---"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/conv_str_logi.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a character of a yaml boolean to a logical value — conv_str_logi","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"convert character yaml boolean logical value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/conv_str_logi.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"","code":"conv_str_logi( input, name = \"\", pos_logi = c(\"TRUE\", \"true\", \"True\", \"yes\", \"y\", \"Y\", \"on\"), neg_logi = c(\"FALSE\", \"false\", \"False\", \"no\", \"n\", \"N\", \"off\"), silent = TRUE )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/conv_str_logi.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"input character name charcter pos_logi character vector yaml values treated TRUE. neg_logi character vector yaml values treated FALSE. silent logical suppress messages warnings.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/conv_str_logi.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"input argument appropriate logical value.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/conv_str_logi.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a character of a yaml boolean to a logical value — conv_str_logi","text":"","code":"conv_str_logi <- getFromNamespace(\"conv_str_logi\", \"teal.reporter\") conv_str_logi(\"TRUE\") #> [1] TRUE conv_str_logi(\"True\") #> [1] TRUE conv_str_logi(\"off\") #> [1] FALSE conv_str_logi(\"n\") #> [1] FALSE conv_str_logi(\"sth\") #> [1] \"sth\""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Download Button Server — download_report_button_srv","title":"Download Button Server — download_report_button_srv","text":"server downloading Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download Button Server — download_report_button_srv","text":"","code":"download_report_button_srv( id, reporter, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download Button Server — download_report_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance. global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download Button Server — download_report_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download Button Server — download_report_button_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Download Button Reporter User Interface — download_report_button_ui","title":"Download Button Reporter User Interface — download_report_button_ui","text":"button downloading Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download Button Reporter User Interface — download_report_button_ui","text":"","code":"download_report_button_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download Button Reporter User Interface — download_report_button_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/download_report_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download Button Reporter User Interface — download_report_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_bs_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bootstrap current version — get_bs_version","title":"Get bootstrap current version — get_bs_version","text":"Get bootstrap current version","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_bs_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bootstrap current version — get_bs_version","text":"","code":"get_bs_version()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_bs_version.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Get bootstrap current version — get_bs_version","text":"work properly mainly inside tag .renderHook","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_yaml_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"Parses yaml text, extracting specified field. Returns list names list; otherwise, field .","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_yaml_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"","code":"get_yaml_field(yaml_text, field_name)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_yaml_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"yaml_text character vector containing yaml text. field_name name field extract.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/get_yaml_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parses yaml text, extracting the specified field. Returns list names if it's a list;\notherwise, the field itself. — get_yaml_field","text":"field list, returns names elements list; otherwise, returns extracted field.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/md_header.html","id":null,"dir":"Reference","previous_headings":"","what":"wrap a yaml string to the markdown header — md_header","title":"wrap a yaml string to the markdown header — md_header","text":"wrap yaml string markdown header.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/md_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"wrap a yaml string to the markdown header — md_header","text":"","code":"md_header(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/md_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"wrap a yaml string to the markdown header — md_header","text":"x character yaml formatted string.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/md_header.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"wrap a yaml string to the markdown header — md_header","text":"","code":"yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(pdf_document = list(keep_tex = TRUE)) ) md_header <- getFromNamespace(\"md_header\", \"teal.reporter\") md_header(yaml::as.yaml(yaml)) #> [1] \"---\\nauthor: \\\"NEST\\\"\\ntitle: \\\"Report\\\"\\ndate: \\\"07/04/2019\\\"\\noutput:\\n pdf_document:\\n keep_tex: yes\\n---\\n\""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/panel_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Panel group widget — panel_item","text":"","code":"panel_item(title, ..., collapsed = TRUE, input_id = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/panel_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Panel group widget — panel_item","text":"title (character) title panel ... content panel collapsed (logical, optional) whether initially collapse panel input_id (character, optional) name panel item element. supplied, register shiny input variable indicates whether panel item open collapsed accessed input$input_id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/panel_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Panel group widget — panel_item","text":"(shiny.tag)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/print.rmd_yaml_header.html","id":null,"dir":"Reference","previous_headings":"","what":"Print method for the yaml_header class — print.rmd_yaml_header","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"Print method yaml_header class.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/print.rmd_yaml_header.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"","code":"# S3 method for rmd_yaml_header print(x, ...)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/print.rmd_yaml_header.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"x rmd_yaml_header class object. ... optional text.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/print.rmd_yaml_header.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print method for the yaml_header class — print.rmd_yaml_header","text":"","code":"input <- list(author = \"\", output = \"pdf_document\", toc = TRUE, keep_tex = TRUE) out <- as_yaml_auto(input) out #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> --- print(out) #> --- #> author: '' #> output: #> pdf_document: #> toc: yes #> keep_tex: yes #> ---"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/report_render_and_compress.html","id":null,"dir":"Reference","previous_headings":"","what":"Render the Report — report_render_and_compress","title":"Render the Report — report_render_and_compress","text":"render report zip created directory.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/report_render_and_compress.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render the Report — report_render_and_compress","text":"","code":"report_render_and_compress( reporter, input_list, global_knitr, file = tempdir() )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/report_render_and_compress.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render the Report — report_render_and_compress","text":"reporter Reporter instance. input_list list like shiny input converted regular named list. global_knitr list global knitr parameters, like echo. local parameter set priority. file character copy returned directory.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/report_render_and_compress.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render the Report — report_render_and_compress","text":"file argument, invisibly.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_download_inputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the custom list of User Interface inputs — reporter_download_inputs","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"Get custom list User Interface inputs","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_download_inputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"","code":"reporter_download_inputs(rmd_yaml_args, rmd_output, showrcode, session)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_download_inputs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the custom list of User Interface inputs — reporter_download_inputs","text":"rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Previewer Server — reporter_previewer_srv","title":"Reporter Previewer Server — reporter_previewer_srv","text":"server supporting functionalities reporter previewer details see vignette: vignette(\"previewerReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Previewer Server — reporter_previewer_srv","text":"","code":"reporter_previewer_srv( id, reporter, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Previewer Server — reporter_previewer_srv","text":"id character(1) shiny module's id. reporter Reporter instance global_knitr list knitr parameters (passed knitr::opts_chunk$set) customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Reporter Previewer Server — reporter_previewer_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Previewer User Interface — reporter_previewer_ui","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"reporter previewer user interface visualize manipulate already added report Cards","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"","code":"reporter_previewer_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reporter_previewer_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Previewer User Interface — reporter_previewer_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Button Server — reset_report_button_srv","title":"Reset Button Server — reset_report_button_srv","text":"server resetting Report content. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Button Server — reset_report_button_srv","text":"","code":"reset_report_button_srv(id, reporter)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Button Server — reset_report_button_srv","text":"id character(1) shiny module's id. reporter Reporter instance.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Button Server — reset_report_button_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Button Reporter User Interface — reset_report_button_ui","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"button resetting report content. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"","code":"reset_report_button_ui(id, label = NULL)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"id character(1) shiny module's id. label character(1) label icon. default NULL.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/reset_report_button_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Button Reporter User Interface — reset_report_button_ui","text":"shiny::tagList","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_output_arguments.html","id":null,"dir":"Reference","previous_headings":"","what":"Get document output arguments from the rmarkdown package — rmd_output_arguments","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"get document output arguments rmarkdown package","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_output_arguments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"","code":"rmd_output_arguments(output_name, default_values = FALSE)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_output_arguments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"output_name character rmarkdown output name. default_values logical return default values argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_output_arguments.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get document output arguments from the rmarkdown package — rmd_output_arguments","text":"","code":"rmd_output_arguments(\"pdf_document\") #> [1] \"toc\" \"toc_depth\" \"number_sections\" #> [4] \"fig_width\" \"fig_height\" \"fig_crop\" #> [7] \"fig_caption\" \"dev\" \"df_print\" #> [10] \"highlight\" \"template\" \"keep_tex\" #> [13] \"keep_md\" \"latex_engine\" \"citation_package\" #> [16] \"includes\" \"md_extensions\" \"output_extensions\" #> [19] \"pandoc_args\" \"extra_dependencies\" rmd_output_arguments(\"pdf_document\", TRUE) #> $toc #> [1] FALSE #> #> $toc_depth #> [1] 2 #> #> $number_sections #> [1] FALSE #> #> $fig_width #> [1] 6.5 #> #> $fig_height #> [1] 4.5 #> #> $fig_crop #> [1] \"auto\" #> #> $fig_caption #> [1] TRUE #> #> $dev #> [1] \"pdf\" #> #> $df_print #> [1] \"default\" #> #> $highlight #> [1] \"default\" #> #> $template #> [1] \"default\" #> #> $keep_tex #> [1] FALSE #> #> $keep_md #> [1] FALSE #> #> $latex_engine #> [1] \"pdflatex\" #> #> $citation_package #> c(\"default\", \"natbib\", \"biblatex\") #> #> $includes #> NULL #> #> $md_extensions #> NULL #> #> $output_extensions #> NULL #> #> $pandoc_args #> NULL #> #> $extra_dependencies #> NULL #>"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_outputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get document output types from the rmarkdown package — rmd_outputs","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"get document output types rmarkdown package.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_outputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"","code":"rmd_outputs()"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_outputs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"character vector.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/rmd_outputs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get document output types from the rmarkdown package — rmd_outputs","text":"","code":"rmd_outputs() #> [1] \"beamer_presentation\" \"context_document\" #> [3] \"github_document\" \"html_document\" #> [5] \"html_document_base\" \"html_extras_for_document\" #> [7] \"ioslides_presentation\" \"latex_document\" #> [9] \"md_document\" \"odt_document\" #> [11] \"pdf_document\" \"powerpoint_presentation\" #> [13] \"rtf_document\" \"slidy_presentation\" #> [15] \"word_document\""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_srv.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple Reporter Server — simple_reporter_srv","title":"Simple Reporter Server — simple_reporter_srv","text":"three buttons adding cards, downloading resetting Report. add module add_report_card_simple id, download module download_button_simple id reset module reset_button_simple id. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_srv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple Reporter Server — simple_reporter_srv","text":"","code":"simple_reporter_srv( id, reporter, card_fun, global_knitr = getOption(\"teal.reporter.global_knitr\"), rmd_output = c(html = \"html_document\", pdf = \"pdf_document\", powerpoint = \"powerpoint_presentation\", word = \"word_document\"), rmd_yaml_args = list(author = \"NEST\", title = \"Report\", date = as.character(Sys.Date()), output = \"html_document\", toc = FALSE) )"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_srv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple Reporter Server — simple_reporter_srv","text":"id character(1) shiny module's id. reporter Reporter instance. card_fun function returns ReportCard instance, function card argument optional comment argument. global_knitr list global knitr parameters customizing rendering process. rmd_output character vector rmarkdown output types, default possible c(\"pdf_document\", \"html_document\", \"powerpoint_presentation\", \"word_document\"). vector named names appear UI. rmd_yaml_args named list Rmd yaml header fields default values. list result custom subset User Interface inputs download reporter functionality. Default list(author = \"NEST\", title = \"Report\", date = Sys.Date(), output = \"html_document\", toc = FALSE). list must include least \"output\" field. default value \"output\" rmd_output argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_srv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple Reporter Server — simple_reporter_srv","text":"shiny::moduleServer","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_srv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Simple Reporter Server — simple_reporter_srv","text":"access default values global_knitr parameter, use getOption('teal.reporter.global_knitr'). defaults include: echo = TRUE tidy.opts = list(width.cutoff = 60) tidy = TRUE formatR package installed, FALSE otherwise","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_ui.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple Reporter User Interface — simple_reporter_ui","title":"Simple Reporter User Interface — simple_reporter_ui","text":"three buttons adding cards, downloading resetting Report. details see vignette: vignette(\"simpleReporter\", \"teal.reporter\").","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_ui.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple Reporter User Interface — simple_reporter_ui","text":"","code":"simple_reporter_ui(id)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_ui.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple Reporter User Interface — simple_reporter_ui","text":"id character(1) shiny module's id.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_ui.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple Reporter User Interface — simple_reporter_ui","text":"shiny.tag","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/simple_reporter_ui.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Simple Reporter User Interface — simple_reporter_ui","text":"","code":"if (interactive()) { shiny::shinyApp( ui = shiny::fluidPage(simple_reporter_ui(\"simple\")), server = function(input, output, session) { simple_reporter_srv(\"simple\", Reporter$new(), function(card) card) } ) }"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/split_text_block.html","id":null,"dir":"Reference","previous_headings":"","what":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"Divide text block smaller blocks.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/split_text_block.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"","code":"split_text_block(x, n)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/split_text_block.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"n integer number lines per block block_text character string containing input block text","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/split_text_block.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"List character strings n lines element.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/split_text_block.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Split a text block into smaller blocks with a specified number of lines. — split_text_block","text":"single character string containing text block multiple lines (separated \\n) split multiple strings n less lines .","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/teal.reporter.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporting tools for shiny modules. — teal.reporter","title":"Reporting tools for shiny modules. — teal.reporter","text":"collection tools creating, previewing modifying reports shiny modules.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/teal.reporter.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Reporting tools for shiny modules. — teal.reporter","text":"Maintainer: Dawid Kaledkowski dawid.kaledkowski@roche.com Authors: Maciej Nasinski Konrad Pagacz Mahmoud mahmoud.hallal@roche.com Hallal contributors: F. Hoffmann-La Roche AG [copyright holder, funder]","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/to_flextable.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"Convert content flextable, merge cells colspan > 1 align columns center, row names left Indent row names 10 times indentation","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/to_flextable.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"","code":"to_flextable(content)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/to_flextable.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"content Supported formats: data.frame, rtables, TableTree, ElementaryTable, listing_df","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/to_flextable.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert content into a flextable, merge cells with colspan > 1\nalign columns to the center, and row names to the left\nIndent the row names by 10 times indentation — to_flextable","text":"(flextable)","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/yaml_quoted.html","id":null,"dir":"Reference","previous_headings":"","what":"quoted string for yaml — yaml_quoted","title":"quoted string for yaml — yaml_quoted","text":"add quoted attribute yaml package","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/yaml_quoted.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"quoted string for yaml — yaml_quoted","text":"","code":"yaml_quoted(x)"},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/yaml_quoted.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"quoted string for yaml — yaml_quoted","text":"x character","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/reference/yaml_quoted.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"quoted string for yaml — yaml_quoted","text":"","code":"yaml_quoted <- getFromNamespace(\"yaml_quoted\", \"teal.reporter\") yaml <- list( author = yaml_quoted(\"NEST\"), title = yaml_quoted(\"Report\"), date = yaml_quoted(\"07/04/2019\"), output = list(pdf_document = list(keep_tex = TRUE)) ) yaml::as.yaml(yaml) #> [1] \"author: \\\"NEST\\\"\\ntitle: \\\"Report\\\"\\ndate: \\\"07/04/2019\\\"\\noutput:\\n pdf_document:\\n keep_tex: yes\\n\""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"tealreporter-0219015","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.2.1.9015","title":"teal.reporter 0.2.1.9015","text":"add_card_button_srv allows specify card_fun label parameter card’s title & content customization. Supports automatic Rcode formatting using suggested formatR package reports.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"tealreporter-021","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.2.1","title":"teal.reporter 0.2.1","text":"CRAN release: 2023-09-08","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"miscellaneous-0-2-1","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.2.1","text":"Specify minimal version dependent packages. Updated TableBlock convert tables flextables show rendered report. Fixed CRAN requirements first CRAN submission. Removed manual pages non-exported objects. Fixed CRAN requirements first CRAN submission.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"teal.reporter 0.2.0","text":"Added new RcodeBlock block custom rmarkdown r chunk. Added collapsible panel Show R Code previewer. Added additional input needed decide “Show R Code” part rendered report. Added possibility add personalized card name adding card. Added support custom inputs download previewer modules.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"breaking-changes-0-2-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"teal.reporter 0.2.0","text":"Simplified reporter_previewer_ui contain just id argument.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"enhancements-0-2-0","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"teal.reporter 0.2.0","text":"Changed modal button colors align purpose modals. Updated AddCardModule comment input active cursor adding card. Updated report previewer support preview multiline comment. Added support table contents reporter documents. Added support global knitr options render method Render class. Improved look remove card modal previewer module.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"miscellaneous-0-2-0","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.2.0","text":"Updated append_src method TealReportCard add additional “R Code” Subtitle.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"new-features-0-1-1","dir":"Changelog","previous_headings":"","what":"New features","title":"teal.reporter 0.1.1","text":"Added Archiver class enables saving loading back Report shiny session.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"breaking-changes-0-1-1","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"teal.reporter 0.1.1","text":"Updated append_fs method TealReportCard accept list object.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"enhancements-0-1-1","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"teal.reporter 0.1.1","text":"Added support ElementaryTree class append_table method ReportCard. Added additional validation card_fun evaluation. Added support arguments setup card_fun function add_card_button_srv module, card_fun subset possible arguments now. Added optional dim argument append_plot method ReportCard. Added support Heatmap plots PictureBlock. Updated append_encodings, append_src append_fs automatically add titles. Updated vignettes README content. Made document type names user friendly downloading report. Improved add reporter card button disabled clicked.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"bug-fixes-0-1-1","dir":"Changelog","previous_headings":"","what":"Bug fixes","title":"teal.reporter 0.1.1","text":"Fixed trellis plots catched set_content method PictureBlock.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"miscellaneous-0-1-1","dir":"Changelog","previous_headings":"","what":"Miscellaneous","title":"teal.reporter 0.1.1","text":"Added to_list from_list methods content related classes. Decoupled metadata content ReportCard.","code":""},{"path":"https://insightsengineering.github.io/teal.reporter/main/news/index.html","id":"tealreporter-010","dir":"Changelog","previous_headings":"","what":"teal.reporter 0.1.0","title":"teal.reporter 0.1.0","text":"Initialize package.","code":""}]