From b627fb1a0eec3cf726ec7f72845b4cb3f2fc2e7d Mon Sep 17 00:00:00 2001
From: Stefan Kuethe <stefan.kuethe@eoda.de>
Date: Fri, 13 Sep 2024 17:18:36 +0200
Subject: [PATCH] Add getting started vignette

---
 .Rbuildignore                     |  1 +
 DESCRIPTION                       |  1 +
 vignettes/.gitignore              |  2 +
 vignettes/articles/rtabulator.Rmd | 76 +++++++++++++++++++++++++++++++
 4 files changed, 80 insertions(+)
 create mode 100644 vignettes/.gitignore
 create mode 100644 vignettes/articles/rtabulator.Rmd

diff --git a/.Rbuildignore b/.Rbuildignore
index 9d40670..0704879 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -10,3 +10,4 @@ _NAMESPACE
 ^pkgdown$
 ^\.github$
 images/
+^vignettes/articles$
diff --git a/DESCRIPTION b/DESCRIPTION
index 958874b..34a5106 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -24,3 +24,4 @@ Imports:
     purrr,
     readr,
     shiny
+Config/Needs/website: rmarkdown
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
new file mode 100644
index 0000000..097b241
--- /dev/null
+++ b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/articles/rtabulator.Rmd b/vignettes/articles/rtabulator.Rmd
new file mode 100644
index 0000000..3927663
--- /dev/null
+++ b/vignettes/articles/rtabulator.Rmd
@@ -0,0 +1,76 @@
+---
+title: "rtabulator"
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+rtabulator provides R bindings for [Tabulator JS](https://tabulator.info/).
+
+The goal of rtabulator is to make it easy to create elegant and interactive tables in markdown documents and [Shiny](https://shiny.posit.co/) applications. Furthermore, it support creating spreadsheets with multiple sheets.
+
+```{r setup}
+library(rtabulator)
+```
+
+## Basic Usage
+
+To render a table just pass a data frame to the `tabulator` function:
+
+```{r}
+tabulator(airquality)
+```
+
+In this case, the column definitions are automatically created for you. The horizontal alignment for
+character columns is set to _left_  while numeric columns are aligned _right_.
+
+## Setup Options
+
+With `tabulator_options` you can customize your table (or spreadsheet):
+
+```{r}
+setup <- tabulator_options(
+  pagination = TRUE,
+  pagination_size = 10,
+  pagination_size_selector = c(10, 20, 50)
+)
+
+tabulator(USArrests, setup)
+```
+
+## Column Formatters
+
+To customize your columns the easiest way is to use the `set_formatter_*` functions: 
+
+```{r}
+tabulator(airquality) |>
+  set_formatter_progress("Temp", legend = TRUE, legend_align = "left") |>
+  set_formatter_traffic_light("Ozone")
+```
+
+## Multi Column headers
+
+You can create multi column headers with `set_multi_column_header`:
+
+```{r}
+headers <- list(
+  Sepal = c("Sepal_Width", "Sepal_Length"),
+  Petal = c("Petal_Width", "Petal_Length")
+)
+
+tabulator(iris) |>
+  set_multi_column_header(headers)
+```
+
+## Spreadsheets
+
+To create an empty spreadsheet just pass an empty list as `data` parameter and `spreadsheet = TRUE`
+to the `tabulator` function:
+
+```{r}
+tabulator(data = list(), spreadsheet = TRUE)
+```