Getting Started with teal.reporter

Introduction

There are times when you explore data in your shiny module, spot an interesting finding and capture it, be it in your slides presentation, a markdown article or another medium. teal.reporter helps you enhance a shiny module so its users do not have to copy-paste and save every finding or write their own markdown to show it.

teal.reporter gives you ready to use shiny modules and objects that work together to prepare reports from your module with minimal input from users of the shiny modules and from you as its developer.

And it can be done as easy as adding one of the reporting tools to your module:

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)

Where to next