https://github.com/insightsengineering/teal.reporter

Create and preview reports with Shiny modules
https://github.com/insightsengineering/teal.reporter

nest r reporting shiny

Last synced: 6 days ago
JSON representation

Create and preview reports with Shiny modules

• Host: GitHub
• URL: https://github.com/insightsengineering/teal.reporter
• Owner: insightsengineering
• License: other
• Created: 2022-03-28T14:15:54.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-10T13:38:36.000Z (8 days ago)
• Last Synced: 2025-04-10T14:52:44.326Z (8 days ago)
• Topics: nest, r, reporting, shiny
• Language: R
• Homepage: https://insightsengineering.github.io/teal.reporter/
• Size: 21.9 MB
• Stars: 8
• Watchers: 13
• Forks: 10
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-shiny-extensions - teal.reporter - Reporting tools for Shiny modules. (Frameworks / Framework extensions)

README

        
# teal.reporter

[![CRAN Version](https://www.r-pkg.org/badges/version/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)

[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)

[![Last Month Downloads](http://cranlogs.r-pkg.org/badges/last-month/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)

[![Last Week Downloads](http://cranlogs.r-pkg.org/badges/last-week/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)

[![Check 🛠](https://github.com/insightsengineering/teal.reporter/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/teal.reporter/main/unit-test-report/)

[![Docs 📚](https://github.com/insightsengineering/teal.reporter/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/teal.reporter/latest-tag/)

[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/teal.reporter/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/teal.reporter/main/coverage-report/)

![GitHub forks](https://img.shields.io/github/forks/insightsengineering/teal.reporter?style=social)

![GitHub Repo stars](https://img.shields.io/github/stars/insightsengineering/teal.reporter?style=social)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/insightsengineering/teal.reporter)

![GitHub contributors](https://img.shields.io/github/contributors/insightsengineering/teal.reporter)

![GitHub last commit](https://img.shields.io/github/last-commit/insightsengineering/teal.reporter)

![GitHub pull requests](https://img.shields.io/github/issues-pr/insightsengineering/teal.reporter)

![GitHub repo size](https://img.shields.io/github/repo-size/insightsengineering/teal.reporter)

![GitHub language count](https://img.shields.io/github/languages/count/insightsengineering/teal.reporter)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![Current Version](https://img.shields.io/github/r-package/v/insightsengineering/teal.reporter/main?color=purple\&label=package%20version)](https://github.com/insightsengineering/teal.reporter/tree/main)

[![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/teal.reporter?color=red\&label=open%20issues)](https://github.com/insightsengineering/teal.reporter/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)

`teal.reporter` empowers both `shiny` and `teal` applications to seamlessly integrate reporting functionality. Developers, whether working on a `shiny` app or a `teal` module, define the report's content, while `teal.reporter` takes care of the rest.

This package provides:

* A `shiny` module for adding cards (i.e. items) into a report

* A `shiny` module for previewing the report on-screen

* The ability to download a zip file containing the reports

## Installation

```r

install.packages('teal.reporter')

```

Alternatively, you might want to use the development version.

```r

# install.packages("pak")

pak::pak("insightsengineering/teal.reporter")

```

## Usage

To understand how to use this package, please refer to the [Getting Started](https://insightsengineering.github.io/teal.reporter/latest-tag/articles/teal-reporter.html) article, which provides multiple examples of code implementation.

![Showcase](https://github.com/insightsengineering/teal.reporter/blob/main/assets/img/showcase.gif)

## Getting help

If you encounter a bug or have a feature request, please file an issue. For questions, discussions, and staying up to date, please use the `teal` channel in the [`pharmaverse` slack workspace](https://pharmaverse.slack.com).

## Stargazers and Forkers

### Stargazers over time

[![Stargazers over time](https://starchart.cc/insightsengineering/teal.reporter.svg)](https://starchart.cc/insightsengineering/teal.reporter)

### Stargazers

[![Stargazers repo roster for @insightsengineering/teal.reporter](http://reporoster.com/stars/insightsengineering/teal.reporter)](https://github.com/insightsengineering/teal.reporter/stargazers)

### Forkers

[![Forkers repo roster for @insightsengineering/teal.reporter](http://reporoster.com/forks/insightsengineering/teal.reporter)](https://github.com/insightsengineering/teal.reporter/network/members)