rtabulator/README.Rmd at main · eoda-dev/rtabulator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rtabulator

<!-- badges: start -->
[![R-CMD-check](https://github.com/eoda-dev/rtabulator/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/eoda-dev/rtabulator/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/rtabulator)](https://CRAN.R-project.org/package=rtabulator)
[![Tabulator](https://img.shields.io/badge/Tabulator-v6.2.5-blue.svg)](https://github.com/olifolkerd/tabulator/releases/tag/6.2.5)
[![Codecov test coverage](https://codecov.io/gh/eoda-dev/rtabulator/graph/badge.svg)](https://app.codecov.io/gh/eoda-dev/rtabulator)
<!-- badges: end -->

The goal of rtabulator is to make it a breeze creating beautiful and interactive tables in markdown documents and Shiny application using [Tabulator JS](https://tabulator.info/).

## Features

* Filtering
* Grouping
* Editing
* Input validation
* History with undo and redo actions
* Pagination
* Layout
* Column formatters
* Column calculations
* Multi column headers
* Packaged themes
* Spreadsheets supporting multiple sheets
* Download data
* Freeze data

To learn more about rtabulator, see the documentation at [https://eoda-dev.github.io/rtabulator/](https://eoda-dev.github.io/rtabulator/).

Bindings for Python are available at [https://github.com/eoda-dev/py-tabulator](https://github.com/eoda-dev/py-tabulator).

## Installation

You can install the released version of rtabulator from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("rtabulator")
```

You can install the development version of rtabulator like so:

``` r
remotes::install_github("eoda-dev/rtabulator")
```

## Basic usage

``` r
library(rtabulator)

tabulator(mtcars)

# Set theme
tabulator(iris, theme = "midnight")

# Format columns
tabulator(airquality) |>
  set_formatter_progress(
    column = "Temp",
    legend = TRUE,
    legend_align = "left"
  )

# Spreadsheet mode
tabulator(data = list(), spreadsheet = TRUE)
```

## Shiny

``` r
shiny::runGitHub("eoda-dev/rtabulator", subdir = "examples/shiny/titanic")
```