From 58cc7cb65a82e4ceb17f3ad21b790e15cb0b7deb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 18 Jan 2024 08:13:24 +0000 Subject: [PATCH] Update pkgdown documentation 69fc4386da93a2579ec38edd05a1b7bf7dc6d456 --- main/404.html | 19 +- main/CODE_OF_CONDUCT.html | 17 +- main/CONTRIBUTING.html | 17 +- main/LICENSE-text.html | 17 +- main/SECURITY.html | 17 +- main/articles/index.html | 17 +- main/articles/previewerReporter.html | 19 +- main/articles/simpleReporter.html | 19 +- main/articles/teal-reporter.html | 19 +- main/authors.html | 25 +- .../bootstrap-5.2.2/bootstrap.bundle.min.js | 7 - .../bootstrap.bundle.min.js.map | 1 - main/deps/bootstrap-5.2.2/bootstrap.min.css | 6 - .../bootstrap-5.3.1/bootstrap.bundle.min.js | 7 + .../bootstrap.bundle.min.js.map | 1 + main/deps/bootstrap-5.3.1/bootstrap.min.css | 5 + main/deps/bootstrap-5.3.1/font.css | 124 ++++++++++ ...txg8zYS_SKggPN4iEgvnHyvveLxVs9pbCIPrc.woff | Bin 0 -> 27828 bytes ...txg8zYS_SKggPN4iEgvnHyvveLxVvaorCIPrc.woff | Bin 0 -> 27492 bytes .../1adeadb2fe618c5ed46221f15e12b9c8.woff | Bin 0 -> 46088 bytes .../fonts/4iCs6KVjbNBYlgo6ew.woff | Bin 0 -> 134032 bytes .../fonts/4iCs6KVjbNBYlgoKfw7w.woff | Bin 0 -> 39832 bytes .../fonts/4iCv6KVjbNBYlgoCxCvTtA.woff | Bin 0 -> 117140 bytes .../fonts/4iCv6KVjbNBYlgoCxCvjsGyL.woff | Bin 0 -> 34452 bytes .../6xK1dSBYKcSV-LCoeQqfX1RYOo3qPZ7nsDQ.woff | Bin 0 -> 17760 bytes .../6xK1dSBYKcSV-LCoeQqfX1RYOo3qPa7j.woff | Bin 0 -> 49156 bytes .../fonts/6xK3dSBYKcSV-LCoeQqfX1RYOo3aPA.woff | Bin 0 -> 74684 bytes .../6xK3dSBYKcSV-LCoeQqfX1RYOo3qOK7j.woff | Bin 0 -> 18420 bytes .../6xKydSBYKcSV-LCoeQqfX1RYOo3i54rAkw.woff | Bin 0 -> 74348 bytes .../6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vAkw.woff | Bin 0 -> 74332 bytes .../6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlxdo.woff | Bin 0 -> 18388 bytes .../6xKydSBYKcSV-LCoeQqfX1RYOo3ik4zAkw.woff | Bin 0 -> 74148 bytes .../6xKydSBYKcSV-LCoeQqfX1RYOo3ik4zwlxdo.woff | Bin 0 -> 18340 bytes .../fonts/CSR54z1Qlv-GDxkbKVQ_dFsvWNRevw.woff | Bin 0 -> 16724 bytes .../fonts/CSR54z1Qlv-GDxkbKVQ_dFsvaNA.woff | Bin 0 -> 29672 bytes .../fonts/CSR64z1Qlv-GDxkbKVQ_TOQ.woff | Bin 0 -> 75128 bytes .../fonts/CSR64z1Qlv-GDxkbKVQ_fOAKSw.woff | Bin 0 -> 16516 bytes ...xRpg3hIP6sJ7fM7PqPMcMnZFqUwX28DBKXhM0.woff | Bin 0 -> 55992 bytes ...xRpg3hIP6sJ7fM7PqPMcMnZFqUwX28DMyQhM0.woff | Bin 0 -> 56004 bytes ...g3hIP6sJ7fM7PqlOPHYvDP_W9O7GQTTbI1rSg.woff | Bin 0 -> 47720 bytes ...g3hIP6sJ7fM7PqlOPHYvDP_W9O7GQTTsoprSg.woff | Bin 0 -> 47924 bytes ...HjIg1_i6t8kCHKm4532VJOt5-QNFgpCtZ6Ew9.woff | Bin 0 -> 50580 bytes ...HjIg1_i6t8kCHKm4532VJOt5-QNFgpCtr6Ew9.woff | Bin 0 -> 50580 bytes ...HjIg1_i6t8kCHKm4532VJOt5-QNFgpCuM70w9.woff | Bin 0 -> 51108 bytes .../fonts/KFOlCnqEu92Fr1MmEU9fBBc-.woff | Bin 0 -> 20544 bytes .../fonts/KFOlCnqEu92Fr1MmEU9vAA.woff | Bin 0 -> 65756 bytes .../fonts/KFOlCnqEu92Fr1MmSU5fBBc-.woff | Bin 0 -> 20416 bytes .../fonts/KFOlCnqEu92Fr1MmSU5vAA.woff | Bin 0 -> 65164 bytes .../fonts/KFOlCnqEu92Fr1MmWUlfBBc-.woff | Bin 0 -> 20408 bytes .../fonts/KFOlCnqEu92Fr1MmWUlvAA.woff | Bin 0 -> 65556 bytes .../fonts/KFOmCnqEu92Fr1Me5g.woff | Bin 0 -> 65456 bytes .../fonts/KFOmCnqEu92Fr1Mu4mxM.woff | Bin 0 -> 20344 bytes .../fonts/QGYpz_kZZAGCONcK2A4bGOj8mNhL.woff | Bin 0 -> 89776 bytes .../fonts/S6u8w4BMUTPHjxsAXC-s.woff | Bin 0 -> 29864 bytes .../fonts/S6u8w4BMUTPHjxswWA.woff | Bin 0 -> 35436 bytes .../fonts/S6u9w4BMUTPHh6UVSwiPHw.woff | Bin 0 -> 28044 bytes .../fonts/S6u9w4BMUTPHh6UVeww.woff | Bin 0 -> 33296 bytes .../fonts/S6u9w4BMUTPHh7USSwiPHw.woff | Bin 0 -> 30016 bytes .../fonts/S6u9w4BMUTPHh7USeww.woff | Bin 0 -> 35168 bytes .../fonts/S6uyw4BMUTPHjx4wWA.woff | Bin 0 -> 28648 bytes .../fonts/S6uyw4BMUTPHvxo.woff | Bin 0 -> 34020 bytes ...HuS_fvQtMwCp50KnMw2boKoduKmMEVuFuYMZs.woff | Bin 0 -> 138900 bytes ...HuS_fvQtMwCp50KnMw2boKoduKmMEVuI6fMZs.woff | Bin 0 -> 137508 bytes ...HuS_fvQtMwCp50KnMw2boKoduKmMEVuLyfMZs.woff | Bin 0 -> 128192 bytes .../XRXI3I6Li01BKofiOc5wtlZ2di8HDFwmRTA.woff | Bin 0 -> 53216 bytes .../XRXI3I6Li01BKofiOc5wtlZ2di8HDGUmRTA.woff | Bin 0 -> 54196 bytes .../XRXI3I6Li01BKofiOc5wtlZ2di8HDLshRTA.woff | Bin 0 -> 53856 bytes .../a98f7a7574819ba83bec6279a2cecd95.woff | Bin 0 -> 45884 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk0ZjaVQ.woff | Bin 0 -> 72136 bytes ...SCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkWVAexg.woff | Bin 0 -> 23636 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkaVQ.woff | Bin 0 -> 74700 bytes ...SCEkx2cmqvXlWq8tWZ0Pw86hd0Rk8ZkWVAexg.woff | Bin 0 -> 23576 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk8ZkaVQ.woff | Bin 0 -> 74564 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk_RkaVQ.woff | Bin 0 -> 74940 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0RkxhjaVQ.woff | Bin 0 -> 74644 bytes ...SCEkx2cmqvXlWq8tWZ0Pw86hd0RkyFjWVAexg.woff | Bin 0 -> 22964 bytes ...cVXSCEkx2cmqvXlWq8tWZ0Pw86hd0RkyFjaVQ.woff | Bin 0 -> 71660 bytes ...X2vVnXBbObj2OVZyOOSr4dVJWUgsg-1x4gaVQ.woff | Bin 0 -> 22332 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgsg-1y4k.woff | Bin 0 -> 68664 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgsgH1y4k.woff | Bin 0 -> 70652 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgshZ1y4k.woff | Bin 0 -> 69392 bytes ...X2vVnXBbObj2OVZyOOSr4dVJWUgsiH0B4gaVQ.woff | Bin 0 -> 22940 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgsiH0C4k.woff | Bin 0 -> 70524 bytes ...X2vVnXBbObj2OVZyOOSr4dVJWUgsjZ0B4gaVQ.woff | Bin 0 -> 22908 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgsjZ0C4k.woff | Bin 0 -> 70792 bytes ...vWbX2vVnXBbObj2OVZyOOSr4dVJWUgsjr0C4k.woff | Bin 0 -> 71144 bytes .../fonts/q5uGsou0JOdh94bfvQlr.woff | Bin 0 -> 31584 bytes main/deps/data-deps.txt | 4 +- main/index.html | 19 +- main/news/index.html | 19 +- main/pkgdown.yml | 2 +- main/pull_request_template.html | 17 +- main/reference/Archiver.html | 41 +-- main/reference/ContentBlock.html | 82 ++++-- main/reference/FileArchiver.html | 59 +++-- main/reference/FileBlock.html | 62 +++-- main/reference/JSONArchiver.html | 208 ++++++++++++++-- main/reference/NewpageBlock.html | 36 +-- main/reference/RcodeBlock.html | 142 +++++++++-- main/reference/Renderer.html | 234 ++++++++++++++++-- main/reference/ReportCard.html | 54 ++-- main/reference/Reporter.html | 29 +-- main/reference/TableBlock.html | 38 +-- main/reference/TextBlock.html | 129 ++++++++-- main/reference/add_card_button_srv.html | 17 +- main/reference/add_card_button_ui.html | 17 +- main/reference/as_yaml_auto.html | 17 +- main/reference/conv_str_logi.html | 35 +-- .../reference/download_report_button_srv.html | 17 +- main/reference/download_report_button_ui.html | 17 +- main/reference/get_bs_version.html | 17 +- main/reference/get_yaml_field.html | 17 +- main/reference/index.html | 17 +- main/reference/md_header.html | 31 +-- main/reference/panel_item.html | 17 +- main/reference/print.rmd_yaml_header.html | 17 +- .../reference/report_render_and_compress.html | 17 +- main/reference/reporter_download_inputs.html | 17 +- main/reference/reporter_previewer_srv.html | 17 +- main/reference/reporter_previewer_ui.html | 17 +- main/reference/reset_report_button_srv.html | 17 +- main/reference/reset_report_button_ui.html | 17 +- main/reference/rmd_output_arguments.html | 17 +- main/reference/rmd_outputs.html | 17 +- main/reference/simple_reporter_srv.html | 17 +- main/reference/simple_reporter_ui.html | 17 +- main/reference/split_text_block.html | 17 +- main/reference/teal.reporter.html | 17 +- main/reference/to_flextable.html | 17 +- main/reference/yaml_quoted.html | 30 +-- main/search.json | 2 +- 131 files changed, 1191 insertions(+), 810 deletions(-) delete mode 100644 main/deps/bootstrap-5.2.2/bootstrap.bundle.min.js delete mode 100644 main/deps/bootstrap-5.2.2/bootstrap.bundle.min.js.map delete mode 100644 main/deps/bootstrap-5.2.2/bootstrap.min.css create mode 100644 main/deps/bootstrap-5.3.1/bootstrap.bundle.min.js create mode 100644 main/deps/bootstrap-5.3.1/bootstrap.bundle.min.js.map create mode 100644 main/deps/bootstrap-5.3.1/bootstrap.min.css create mode 100644 main/deps/bootstrap-5.3.1/font.css create mode 100644 main/deps/bootstrap-5.3.1/fonts/1Ptxg8zYS_SKggPN4iEgvnHyvveLxVs9pbCIPrc.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/1Ptxg8zYS_SKggPN4iEgvnHyvveLxVvaorCIPrc.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/1adeadb2fe618c5ed46221f15e12b9c8.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/4iCs6KVjbNBYlgo6ew.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/4iCs6KVjbNBYlgoKfw7w.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/4iCv6KVjbNBYlgoCxCvTtA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/4iCv6KVjbNBYlgoCxCvjsGyL.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xK1dSBYKcSV-LCoeQqfX1RYOo3qPZ7nsDQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xK1dSBYKcSV-LCoeQqfX1RYOo3qPa7j.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xK3dSBYKcSV-LCoeQqfX1RYOo3aPA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xK3dSBYKcSV-LCoeQqfX1RYOo3qOK7j.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xKydSBYKcSV-LCoeQqfX1RYOo3i54rAkw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vAkw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlxdo.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xKydSBYKcSV-LCoeQqfX1RYOo3ik4zAkw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/6xKydSBYKcSV-LCoeQqfX1RYOo3ik4zwlxdo.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/CSR54z1Qlv-GDxkbKVQ_dFsvWNRevw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/CSR54z1Qlv-GDxkbKVQ_dFsvaNA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/CSR64z1Qlv-GDxkbKVQ_TOQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/CSR64z1Qlv-GDxkbKVQ_fOAKSw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/HI_diYsKILxRpg3hIP6sJ7fM7PqPMcMnZFqUwX28DBKXhM0.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/HI_diYsKILxRpg3hIP6sJ7fM7PqPMcMnZFqUwX28DMyQhM0.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/HI_jiYsKILxRpg3hIP6sJ7fM7PqlOPHYvDP_W9O7GQTTbI1rSg.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/HI_jiYsKILxRpg3hIP6sJ7fM7PqlOPHYvDP_W9O7GQTTsoprSg.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/JTUHjIg1_i6t8kCHKm4532VJOt5-QNFgpCtZ6Ew9.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/JTUHjIg1_i6t8kCHKm4532VJOt5-QNFgpCtr6Ew9.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/JTUHjIg1_i6t8kCHKm4532VJOt5-QNFgpCuM70w9.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmEU9fBBc-.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmEU9vAA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmSU5fBBc-.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmSU5vAA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmWUlfBBc-.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOlCnqEu92Fr1MmWUlvAA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOmCnqEu92Fr1Me5g.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/KFOmCnqEu92Fr1Mu4mxM.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/QGYpz_kZZAGCONcK2A4bGOj8mNhL.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u8w4BMUTPHjxsAXC-s.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u8w4BMUTPHjxswWA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u9w4BMUTPHh6UVSwiPHw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u9w4BMUTPHh6UVeww.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u9w4BMUTPHh7USSwiPHw.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6u9w4BMUTPHh7USeww.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6uyw4BMUTPHjx4wWA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/S6uyw4BMUTPHvxo.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/UcCO3FwrK3iLTeHuS_fvQtMwCp50KnMw2boKoduKmMEVuFuYMZs.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/UcCO3FwrK3iLTeHuS_fvQtMwCp50KnMw2boKoduKmMEVuI6fMZs.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/UcCO3FwrK3iLTeHuS_fvQtMwCp50KnMw2boKoduKmMEVuLyfMZs.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/XRXI3I6Li01BKofiOc5wtlZ2di8HDFwmRTA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/XRXI3I6Li01BKofiOc5wtlZ2di8HDGUmRTA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/XRXI3I6Li01BKofiOc5wtlZ2di8HDLshRTA.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/a98f7a7574819ba83bec6279a2cecd95.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk0ZjaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkWVAexg.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk5hkaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk8ZkWVAexg.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk8ZkaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0Rk_RkaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0RkxhjaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0RkyFjWVAexg.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memQYaGs126MiZpBA-UFUIcVXSCEkx2cmqvXlWq8tWZ0Pw86hd0RkyFjaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsg-1x4gaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsg-1y4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsgH1y4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgshZ1y4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsiH0B4gaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsiH0C4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsjZ0B4gaVQ.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsjZ0C4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/memSYaGs126MiZpBA-UvWbX2vVnXBbObj2OVZyOOSr4dVJWUgsjr0C4k.woff create mode 100644 main/deps/bootstrap-5.3.1/fonts/q5uGsou0JOdh94bfvQlr.woff diff --git a/main/404.html b/main/404.html index 4961f8dd..2eb5b09c 100644 --- a/main/404.html +++ b/main/404.html @@ -7,8 +7,8 @@ Page not found (404) • teal.reporter - - + +
  • -
    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 eb6a7df7..63a9cc1b 100644 --- a/main/CODE_OF_CONDUCT.html +++ b/main/CODE_OF_CONDUCT.html @@ -1,5 +1,5 @@ -Contributor Covenant Code of Conduct • teal.reporterContributor Covenant Code of Conduct • teal.reporter @@ -10,7 +10,7 @@ teal.reporter - 0.2.1.9012 + 0.2.1.9014
    part of NESTpharmaverse

    Method finalize()

    @@ -150,6 +143,24 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## Method `Archiver$new`
+## ------------------------------------------------
+
+Archiver <- getFromNamespace("Archiver", "teal.reporter")
+Archiver$new()
+#> <Archiver>
+#>   Public:
+#>     clone: function (deep = FALSE) 
+#>     finalize: function () 
+#>     initialize: function () 
+#>     read: function () 
+#>     write: function () 
+
    +

    diff --git a/main/reference/ContentBlock.html b/main/reference/ContentBlock.html index 5fbf36c5..5fa9a791 100644 --- a/main/reference/ContentBlock.html +++ b/main/reference/ContentBlock.html @@ -1,6 +1,6 @@ ContentBlock — ContentBlock • teal.reporterContentBlock — ContentBlock • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -111,6 +98,13 @@

    DetailsReturns

    ContentBlock

    +
    +

    Examples

    +

    ContentBlock <- getFromNamespace("ContentBlock", "teal.reporter")
+ContentBlock$new()
+

    +
    +

    Method set_content()

    @@ -131,6 +125,14 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    ContentBlock <- getFromNamespace("ContentBlock", "teal.reporter")
+block <- ContentBlock$new()
+block$set_content("Base64 encoded picture")
+

    +
    +

    Method get_content()

    @@ -143,6 +145,14 @@

    Usage

    Returns

    character content of this ContentBlock

    +
    +

    Examples

    +

    ContentBlock <- getFromNamespace("ContentBlock", "teal.reporter")
+block <- ContentBlock$new()
+block$get_content()
+

    +
    +

    Method from_list()

    @@ -197,6 +207,48 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## Method `ContentBlock$new`
+## ------------------------------------------------
+
+ContentBlock <- getFromNamespace("ContentBlock", "teal.reporter")
+ContentBlock$new()
+#> <ContentBlock>
+#>   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)
+
+
    +

    diff --git a/main/reference/FileArchiver.html b/main/reference/FileArchiver.html index 4eec4ffb..ecb98582 100644 --- a/main/reference/FileArchiver.html +++ b/main/reference/FileArchiver.html @@ -1,6 +1,6 @@ RDSArchiver — FileArchiver • teal.reporterRDSArchiver — FileArchiver • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -110,6 +97,12 @@

    Usage

    Returns

    a FileArchiver object

    +
    +

    Examples

    +

    FileArchiver <- getFromNamespace("FileArchiver", "teal.reporter")
+FileArchiver$new()

    +
    +

    Method finalize()

    @@ -130,6 +123,12 @@

    Usage

    Returns

    character a output_dir field path.

    +
    +

    Examples

    +

    FileArchiver <- getFromNamespace("FileArchiver", "teal.reporter")
+FileArchiver$new()$get_output_dir()

    +
    +

    Method clone()

    @@ -151,6 +150,36 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## Method `FileArchiver$new`
+## ------------------------------------------------
+
+FileArchiver <- getFromNamespace("FileArchiver", "teal.reporter")
+FileArchiver$new()
+#> <FileArchiver>
+#>   Inherits from: <Archiver>
+#>   Public:
+#>     clone: function (deep = FALSE) 
+#>     finalize: function () 
+#>     get_output_dir: function () 
+#>     initialize: function () 
+#>     read: function () 
+#>     write: function () 
+#>   Private:
+#>     output_dir: /tmp/RtmpgheIBT/archive_202401180812560927
+
+## ------------------------------------------------
+## Method `FileArchiver$get_output_dir`
+## ------------------------------------------------
+
+FileArchiver <- getFromNamespace("FileArchiver", "teal.reporter")
+FileArchiver$new()$get_output_dir()
+#> [1] "/tmp/RtmpgheIBT/archive_202401180812561074"
+
    +

    diff --git a/main/reference/FileBlock.html b/main/reference/FileBlock.html index 27fd100e..f84ab99c 100644 --- a/main/reference/FileBlock.html +++ b/main/reference/FileBlock.html @@ -1,6 +1,6 @@ FileBlock — FileBlock • teal.reporterFileBlock — FileBlock • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -137,6 +124,16 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    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 to_list()

    @@ -157,6 +154,14 @@

    ArgumentsReturns

    named list with a basename of the file.

    +
    +

    Examples

    +

    FileBlock <- getFromNamespace("FileBlock", "teal.reporter")
+block <- FileBlock$new()
+block$to_list(tempdir())
+

    +
    +

    Method clone()

    @@ -178,6 +183,33 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## 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)
+#> 
+
+
    +

    diff --git a/main/reference/JSONArchiver.html b/main/reference/JSONArchiver.html index 50c87f77..49e48315 100644 --- a/main/reference/JSONArchiver.html +++ b/main/reference/JSONArchiver.html @@ -1,6 +1,6 @@ JSONArchiver — JSONArchiver • teal.reporterJSONArchiver — JSONArchiver • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -118,6 +105,27 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    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()

    +
    +

    Method read()

    @@ -138,6 +146,34 @@

    ArgumentsReturns

    Reporter instance.

    +
    +

    Examples

    +

    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)

    +
    +

    Method clone()

    @@ -159,6 +195,148 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## 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)
+#> <JSONArchiver>
+#>   Inherits from: <FileArchiver>
+#>   Public:
+#>     clone: function (deep = FALSE) 
+#>     finalize: function () 
+#>     get_output_dir: function () 
+#>     initialize: function () 
+#>     read: function (path = NULL) 
+#>     write: function (reporter) 
+#>   Private:
+#>     output_dir: /tmp/RtmpgheIBT/archive_202401180812569381
+archiver$get_output_dir()
+#> [1] "/tmp/RtmpgheIBT/archive_202401180812569381"
+
+## ------------------------------------------------
+## 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)
+#> <JSONArchiver>
+#>   Inherits from: <FileArchiver>
+#>   Public:
+#>     clone: function (deep = FALSE) 
+#>     finalize: function () 
+#>     get_output_dir: function () 
+#>     initialize: function () 
+#>     read: function (path = NULL) 
+#>     write: function (reporter) 
+#>   Private:
+#>     output_dir: /tmp/RtmpgheIBT/archive_202401180812570854
+archiver$get_output_dir()
+#> [1] "/tmp/RtmpgheIBT/archive_202401180812570854"
+
+archiver$read()$get_cards()[[1]]$get_content()
+#> [[1]]
+#> <TextBlock>
+#>   Inherits from: <ContentBlock>
+#>   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]]
+#> <TextBlock>
+#>   Inherits from: <ContentBlock>
+#>   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]]
+#> <PictureBlock>
+#>   Inherits from: <FileBlock>
+#>   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/RtmpgheIBT/file1bc43912f4d.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)
+
    +

    diff --git a/main/reference/NewpageBlock.html b/main/reference/NewpageBlock.html index da67b821..829dc9fd 100644 --- a/main/reference/NewpageBlock.html +++ b/main/reference/NewpageBlock.html @@ -1,6 +1,6 @@ NewpageBlock — NewpageBlock • teal.reporterNewpageBlock — NewpageBlock • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -115,6 +102,13 @@

    DetailsReturns

    NewpageBlock

    +
    +

    Examples

    +

    NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
+block <- NewpageBlock$new()
+

    +
    +

    Method clone()

    @@ -136,6 +130,18 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## Method `NewpageBlock$new`
+## ------------------------------------------------
+
+NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
+block <- NewpageBlock$new()
+
+
    +

    diff --git a/main/reference/RcodeBlock.html b/main/reference/RcodeBlock.html index 2a099551..1dc792c3 100644 --- a/main/reference/RcodeBlock.html +++ b/main/reference/RcodeBlock.html @@ -1,6 +1,6 @@ RcodeBlock — RcodeBlock • teal.reporterRcodeBlock — RcodeBlock • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -130,6 +117,13 @@

    DetailsReturns

    RcodeBlock

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+

    +
    +

    Method set_params()

    @@ -155,6 +149,14 @@

    DetailsReturns

    invisibly self

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+block$set_params(list(echo = TRUE))
+

    +
    +

    Method get_params()

    @@ -167,6 +169,14 @@

    Usage

    Returns

    character the parameters of this RcodeBlock

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+block$get_params()
+

    +
    +

    Method get_available_params()

    @@ -179,6 +189,14 @@

    Usage

    Returns

    a character array of parameters

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+block$get_available_params()
+

    +
    +

    Method from_list()

    @@ -200,6 +218,14 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+block$from_list(list(text = "sth", params = list()))
+

    +
    +

    Method to_list()

    @@ -212,6 +238,14 @@

    Usage

    Returns

    named list with a text and params.

    +
    +

    Examples

    +

    RcodeBlock <- getFromNamespace("RcodeBlock", "teal.reporter")
+block <- RcodeBlock$new()
+block$to_list()
+

    +
    +

    Method clone()

    @@ -233,6 +267,84 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## 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()
+#> 
+
+
    +

    diff --git a/main/reference/Renderer.html b/main/reference/Renderer.html index f6262d05..46a43201 100644 --- a/main/reference/Renderer.html +++ b/main/reference/Renderer.html @@ -1,6 +1,6 @@ Renderer — Renderer • teal.reporterRenderer — Renderer • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -111,6 +98,13 @@

    DetailsReturns

    Renderer object.

    +
    +

    Examples

    +

    Renderer <- getFromNamespace("Renderer", "teal.reporter")
+Renderer$new()
+

    +
    +

    Method finalize()

    @@ -160,6 +154,47 @@

    DetailsReturns

    character a Rmd text (yaml header + body), ready to be rendered.

    +
    +

    Examples

    +

    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)
+

    +
    +

    Method render()

    @@ -206,6 +241,45 @@

    DetailsReturns

    character path to the output

    +
    +

    Examples

    +

    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)
+

    +
    +

    Method get_output_dir()

    @@ -218,6 +292,13 @@

    Usage

    Returns

    character a output_dir field path.

    +
    +

    Examples

    +

    Renderer <- getFromNamespace("Renderer", "teal.reporter")$new()
+Renderer$get_output_dir()
+

    +
    +

    Method clone()

    @@ -239,6 +320,129 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## Method `Renderer$new`
+## ------------------------------------------------
+
+Renderer <- getFromNamespace("Renderer", "teal.reporter")
+Renderer$new()
+#> <Renderer>
+#>   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/RtmpgheIBT/report_202401180812583959
+#>     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/RtmpgheIBT/report_202401180813014643"
+
+
    +

    diff --git a/main/reference/ReportCard.html b/main/reference/ReportCard.html index 90cf5a7f..6fd10120 100644 --- a/main/reference/ReportCard.html +++ b/main/reference/ReportCard.html @@ -1,7 +1,7 @@ ReportCard — ReportCard • teal.reporterReportCard — ReportCard • teal.reporter
  • -
    main -latest-tag -release-candidate -v0.2.1-rc2 -v0.2.1-rc1 -v0.2.1 -v0.2.0 -v0.1.1
    • -
  • @@ -262,6 +249,13 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
+card <- ReportCard$new()$append_content(NewpageBlock$new())
+

    +
    +

    Method get_content()

    @@ -275,7 +269,7 @@

    Returnslist() list of TableBlock, TextBlock and PictureBlock.

    -

    Examples

    +

    Examples

    card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
 
 card$get_content()
@@ -308,7 +302,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
 
 card$get_metadata()
@@ -340,7 +334,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    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",
@@ -363,7 +357,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    ReportCard$new()$set_name("NAME")$get_name()
    
 
    
 
@@ -388,7 +382,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    ReportCard$new()$set_name("NAME")$get_name()
    
 
    
 
@@ -413,7 +407,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    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",
@@ -449,7 +443,7 @@ 
    Returns
-
    Examples
    
+
    Examples
    
 
    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",
@@ -523,6 +517,14 @@ 
    Examples
 
 ## ------------------------------------------------
+## Method `ReportCard$append_content`
+## ------------------------------------------------
+
+NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
+card <- ReportCard$new()$append_content(NewpageBlock$new())
+
+
+## ------------------------------------------------
 ## Method `ReportCard$get_content`
 ## ------------------------------------------------
 
@@ -608,7 +610,7 @@ 
    Examples#>     set_title: function (title) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c06dfdbdb4.png
+#>     content: /tmp/RtmpgheIBT/file1bc5ea408a0.png
 #>     deep_clone: function (name, value) 
 #>     dim: 800 600
 #>     supported_plots: ggplot grob trellis Heatmap
@@ -706,7 +708,7 @@ 
    Examples#>     set_title: function (title) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c0b395d47.png
+#>     content: /tmp/RtmpgheIBT/file1bc1bb7cfdc.png
 #>     deep_clone: function (name, value) 
 #>     dim: 800 600
 #>     supported_plots: ggplot grob trellis Heatmap
@@ -745,7 +747,7 @@ 
    Examples#> 
 #> $blocks$PictureBlock
 #> $blocks$PictureBlock$basename
-#> [1] "file1c0b395d47.png"
+#> [1] "file1bc1bb7cfdc.png"
 #> 
 #> 
 #> $blocks$TextBlock
@@ -816,7 +818,7 @@ 
    Examples#>     set_title: function (title) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c0718562a4.png
+#>     content: /tmp/RtmpgheIBT/file1bc2c8131a0.png
 #>     deep_clone: function (name, value) 
 #>     dim: 800 600
 #>     supported_plots: ggplot grob trellis Heatmap
diff --git a/main/reference/Reporter.html b/main/reference/Reporter.html
index baeef629..124280da 100644
--- a/main/reference/Reporter.html
+++ b/main/reference/Reporter.html
@@ -1,6 +1,6 @@
 
 Reporter — Reporter • teal.reporterReporter — Reporter • teal.reporter 
  • 
-         
     main
-latest-tag
-release-candidate
-v0.2.1-rc2
-v0.2.1-rc1
-v0.2.1
-v0.2.0
-v0.1.1 
    • 
-
 
  • 
   
   
    
@@ -730,7 +717,7 @@ 
    Examples#>     set_title: function (title) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c01f8fc845.png
+#>     content: /tmp/RtmpgheIBT/file1bc54a223ec.png
 #>     deep_clone: function (name, value) 
 #>     dim: 800 600
 #>     supported_plots: ggplot grob trellis Heatmap
@@ -803,7 +790,7 @@ 
    Examples#>     set_content: function (content) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c023c9e80a.rds
+#>     content: /tmp/RtmpgheIBT/file1bc49e5422e.rds
 #>     deep_clone: function (name, value) 
 #>     supported_tables: data.frame rtables TableTree ElementaryTable listing_df
 #> 
@@ -819,7 +806,7 @@ 
    Examples#>     set_content: function (content) 
 #>     to_list: function (output_dir) 
 #>   Private:
-#>     content: /tmp/Rtmp1JezgC/file1c02d050099.rds
+#>     content: /tmp/RtmpgheIBT/file1bc11b2363e.rds
 #>     deep_clone: function (name, value) 
 #>     supported_tables: data.frame rtables TableTree ElementaryTable listing_df
 #> 
@@ -897,7 +884,7 @@ 
    Examplestmp_dir <- file.path(tempdir(), "jsondir")
 dir.create(tmp_dir)
 reporter$to_jsondir(tmp_dir)
-#> [1] "/tmp/Rtmp1JezgC/jsondir"
+#> [1] "/tmp/RtmpgheIBT/jsondir"
 
 ## ------------------------------------------------
 ## Method `Reporter$from_jsondir`
@@ -906,10 +893,10 @@ 
    Examplesreporter <- Reporter$new()
 tmp_dir <- file.path(tempdir(), "jsondir")
 dir.create(tmp_dir)
-#> Warning: '/tmp/Rtmp1JezgC/jsondir' already exists
+#> Warning: '/tmp/RtmpgheIBT/jsondir' already exists
 unlink(list.files(tmp_dir, recursive = TRUE))
 reporter$to_jsondir(tmp_dir)
-#> [1] "/tmp/Rtmp1JezgC/jsondir"
+#> [1] "/tmp/RtmpgheIBT/jsondir"
 reporter$from_jsondir(tmp_dir)
 
    • 
     
    
diff --git a/main/reference/TableBlock.html b/main/reference/TableBlock.html
index 722037a2..5829b71d 100644
--- a/main/reference/TableBlock.html
+++ b/main/reference/TableBlock.html
@@ -1,6 +1,6 @@
 
 TableBlock — TableBlock • teal.reporterTableBlock — TableBlock • teal.reporter 
  • 
-         
     main
-latest-tag
-release-candidate
-v0.2.1-rc2
-v0.2.1-rc1
-v0.2.1
-v0.2.0
-v0.1.1 
    • 
-
 
  • 
   
   
    
@@ -146,6 +133,14 @@ 
    DetailsReturns
    
 
    invisibly self
    
 
    
+
    
+
    Examples
    
+
    TableBlock <- getFromNamespace("TableBlock", "teal.reporter")
+block <- TableBlock$new()
+block$set_content(iris)
+
    
+
    
+
 
 
    • 
 
    Method clone()
    
@@ -167,6 +162,19 @@ 
    Arguments
+    
    Examples
    
+    
    
+## ------------------------------------------------
+## Method `TableBlock$set_content`
+## ------------------------------------------------
+
+TableBlock <- getFromNamespace("TableBlock", "teal.reporter")
+block <- TableBlock$new()
+block$set_content(iris)
+
+
    
+    
    
   
    
 
diff --git a/main/reference/TextBlock.html b/main/reference/TextBlock.html
index 4da8780b..1f52ef63 100644
--- a/main/reference/TextBlock.html
+++ b/main/reference/TextBlock.html
@@ -1,6 +1,6 @@
 
 TextBlock — TextBlock • teal.reporterTextBlock — TextBlock • teal.reporter 
  • 
-         
     main
-latest-tag
-release-candidate
-v0.2.1-rc2
-v0.2.1-rc1
-v0.2.1
-v0.2.0
-v0.1.1 
    • 
-
 
  • 
   
   
    
@@ -130,6 +117,13 @@ 
    DetailsReturns
    
 
    TextBlock
    
 
    
+
    
+
    Examples
    
+
    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+
    
+
    
+
 
 
    • 
 
    Method set_style()
    
@@ -155,6 +149,14 @@ 
    DetailsReturns
    
 
    invisibly self
    
 
    
+
    
+
    Examples
    
+
    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+block$set_style("header2")
+
    
+
    
+
 
 
    
 
    Method get_style()
    
@@ -167,6 +169,14 @@ 
    Usage
 
    Returns
    
 
    character(1) the style of this TextBlock
    
 
    
+
    
+
    Examples
    
+
    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+block$get_style()
+
    
+
    
+

    Method get_available_styles()

    @@ -179,6 +189,14 @@

    Usage

    Returns

    a character array of styles

    +
    +

    Examples

    +

    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+block$get_available_styles()
+

    +
    +

    Method from_list()

    @@ -200,6 +218,14 @@

    ArgumentsReturns

    invisibly self

    +
    +

    Examples

    +

    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+block$from_list(list(text = "sth", style = "default"))
+

    +
    +

    Method to_list()

    @@ -212,6 +238,14 @@

    Usage

    Returns

    named list with a text and style.

    +
    +

    Examples

    +

    TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
+block <- TextBlock$new()
+block$to_list()
+

    +
    +

    Method clone()

    @@ -233,6 +267,71 @@

    Arguments +

    Examples

    + 
    
+## ------------------------------------------------
+## 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"
+#> 
+
+
    +

    diff --git a/main/reference/add_card_button_srv.html b/main/reference/add_card_button_srv.html index 95bc684a..34063015 100644 --- a/main/reference/add_card_button_srv.html +++ b/main/reference/add_card_button_srv.html @@ -1,7 +1,7 @@ Add Card Button Server — add_card_button_srv • teal.reporterAdd Card Button Server — add_card_button_srv • teal.reporter
  • -
    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 9ad98483..be2ddb93 100644 --- a/main/reference/add_card_button_ui.html +++ b/main/reference/add_card_button_ui.html @@ -1,7 +1,7 @@ Add Card Button User Interface — add_card_button_ui • teal.reporterAdd Card Button User Interface — add_card_button_ui • teal.reporter
  • -
    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 3b262763..01bd4abe 100644 --- a/main/reference/as_yaml_auto.html +++ b/main/reference/as_yaml_auto.html @@ -5,7 +5,7 @@ where as a nested list is directly processed with the yaml::as.yaml function. All Rmd yaml header fields from the vector are supported, c("author", "date", "title", "subtitle", "abstract", "keywords", "subject", "description", "category", "lang"). -Moreover all outputfield types in the rmarkdown package and their arguments are supported.'>Parse a Named List to the Rmd yaml Header — as_yaml_auto • teal.reporterParse a Named List to the Rmd yaml Header — as_yaml_auto • teal.reporterDownload Button Server — download_report_button_srv • teal.reporterDownload Button Server — download_report_button_srv • teal.reporter
  • -
    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 7cf2f5a6..b94d201b 100644 --- a/main/reference/download_report_button_ui.html +++ b/main/reference/download_report_button_ui.html @@ -1,7 +1,7 @@ Download Button Reporter User Interface — download_report_button_ui • teal.reporterDownload Button Reporter User Interface — download_report_button_ui • teal.reporter
  • -
    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 ea259bd2..3961bb34 100644 --- a/main/reference/get_bs_version.html +++ b/main/reference/get_bs_version.html @@ -1,5 +1,5 @@ -Get bootstrap current version — get_bs_version • teal.reporterGet bootstrap current version — get_bs_version • teal.reporter @@ -10,7 +10,7 @@ teal.reporter - 0.2.1.9012 + 0.2.1.9014
    part of NESTpharmaverse
    diff --git a/main/reference/panel_item.html b/main/reference/panel_item.html index 93756925..3c8388de 100644 --- a/main/reference/panel_item.html +++ b/main/reference/panel_item.html @@ -1,5 +1,5 @@ -Panel group widget — panel_item • teal.reporterPanel group widget — panel_item • teal.reporter @@ -10,7 +10,7 @@ teal.reporter - 0.2.1.9012 + 0.2.1.9014
    part of NESTpharmaverse