Update docs

DESCRIPTION

@@ -1,15 +1,19 @@
 Package: rtabulator
 Type: Package
 Title: R Bindings for Tabulator JS
-Version: 0.1.0
-Date: 2024-09-08
+Version: 0.1.1
+Date: 2024-09-13
 Authors@R: c(
   person("Stefan", "Kuethe", email = "[email protected]", role = c("aut", "cre")),
   person("Nico", "Friess", email = "[email protected]", role = c("aut"))
   )
 Maintainer: Stefan Kuethe <[email protected]>
 Description: Provides R bindings for 'Tabulator JS' <https://tabulator.info/>.
   Makes it a breeze to create beautiful interactive tables.
+URL:
+  https://github.com/eodaGmbH/rtabulator
+  https://eodagmbh.github.io/rtabulator/
+BugReports: https://github.com/eodaGmbH/rtabulator/issues
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true

NEWS.md

@@ -1,3 +1,12 @@
+# rtabulator 0.1.1
+
+* Update docs
+* Add pkgdown site
+* Add function to create multi column headers
+* Add a lot of examples
+* Update README
+* Make `devtools::check()` pass 🚀
+
 # rtabulator 0.1.0
 
 * Add NEWS.md to track changes.

R/columns.R

@@ -1,4 +1,4 @@
-#' Create columns definition from data
+#' Create column definitions from data
 #' @param data (data.frame) data
 #' @param editor (bool): Whether to make columns editable.
 #' @param filter (bool): Whether to add a header filter to the columns.
@@ -313,8 +313,7 @@ set_formatter_datetime <- function(
     input_format = "yyyy-MM-dd hh:ss:mm",
     output_format = "yy/MM/dd",
     invalid_placeholder = "(invalid datetime)",
-    timezone = NA
-    ) {
+    timezone = NA) {
   # Body
   col_update <- list(
     formatter = "datetime",
@@ -339,6 +338,7 @@ set_formatter_color <- function(widget, column) {
 
 #' Traffic Light Formatter
 #' @inheritParams set_formatter_progress
+#' @example examples/formatters/formatter_traffic_light.R
 #' @export
 set_formatter_traffic_light <- function(
     widget,
@@ -348,9 +348,9 @@ set_formatter_traffic_light <- function(
     color = c("green", "orange", "red"),
     hoz_align = "center") {
   # Body
-  if (is.na(min)) min = min(widget$x$data[column])
+  if (is.na(min)) min <- min(widget$x$data[column])
 
-  if (is.na(max)) max = max(widget$x$data[column])
+  if (is.na(max)) max <- max(widget$x$data[column])
 
   col_update <- list(
     formatter = "traffic",

R/tabulator.R

@@ -12,6 +12,7 @@
 #' @param height Height of the widget.
 #' @param element_id The unique ID of the widget.
 #' @param ... Named arguments that are appended to the \code{options} parameter.
+#' @example examples/multiple_spreadsheets.R
 #' @import htmlwidgets
 #' @export
 tabulator <- function(

R/tabulator_context.R

@@ -14,7 +14,8 @@ invoke_method <- function(widget, method_name, ...) {
   invisible(widget)
 }
 
-#' Create a Tabulator Context
+#' Create a Tabulator Context Object
+#' A \code{tabulatorContext} object makes it possible to update your widget in a Shiny app.
 #' @param output_id (character): A tabulator output id.
 #' @param session shiny session object
 #' @export

R/tabulator_options.R

@@ -32,6 +32,7 @@
 #' @param spreadsheet_sheet_tabs (bool): Whether to show sheet tabs in the footer.
 #' @param ... Further options.
 #' @seealso \url{https://tabulator.info/docs/6.2/options}
+#' @example examples/tabulator_setup.R
 #' @export
 tabulator_options <- function(
     # General

_pkgdown.yml

@@ -2,3 +2,39 @@ url: ~
 template:
   bootstrap: 5
 
+reference:
+  - title: Tabulator Widget
+    desc: >
+      Functions to create and setup a Tabulator widget
+    contents:
+      - tabulator
+      - tabulator_options
+      - set_column_editor
+      - set_header_filter
+      - set_multi_column_header
+
+  - title: Column Formatters
+    desc: >
+      Functions to set column formatters
+    contents:
+      - starts_with("set_formatter")
+
+  - title: Shiny Integration
+    contents:
+      - rtabulator-shiny
+      - tabulatorContext
+      - add_row
+      - delete_selected_rows
+      - trigger_download
+      - trigger_get_data
+      - trigger_get_spreadsheet_data
+      - undo
+      - redo
+
+  - title: Utils
+    desc: >
+      Utitily functions
+    contents:
+      - list_to_data_frame
+      - create_columns
+

examples/formatters/formatter_datetime.R

@@ -1,6 +1,6 @@
 data <- data.frame(
   Person = c("Franz", "Ferdinand"),
-  Birthday =c(
+  Birthday = c(
     "2024-12-06 22:00:10",
     "2023-06-07 14:12:45"
   )

examples/formatters/formatter_html.R

@@ -11,5 +11,5 @@ data <- data.frame(
   )
 )
 
-tabulator(data, width=200) |>
+tabulator(data, width = 400) |>
   set_formatter_html("text_style")

examples/formatters/formatter_money.R

@@ -1,14 +1,14 @@
 data <- data.frame(
-   Account_Number= c(
-      123456,
-      345667,
-      234567,
-      234566
-     ),
+  Account_Number = c(
+    123456,
+    345667,
+    234567,
+    234566
+  ),
   Account_Balance = c(100, -50, 200.30, -21.5)
 )
 
-tabulator(data, width = 300) |>
+tabulator(data) |>
   set_formatter_money(
     "Account_Balance",
     symbol = "\U20AC",

examples/formatters/formatter_progress.R

@@ -7,7 +7,7 @@ data <- data.frame(
 
 js_func <- htmlwidgets::JS("(cellValue) => `${cellValue}%`")
 
-tabulator(data, width = 300) |>
+tabulator(data) |>
   set_formatter_progress("value") |>
   set_formatter_progress("value2", legend = TRUE, legend_align = "left") |>
   set_formatter_progress("value3", legend = js_func, legend_align = "right")

examples/formatters/formatter_textarea.R

@@ -3,7 +3,7 @@ data <- data.frame(
   txt = c(
     "This\nis\nsome\ntext\nwith\nmultiple\nline\nbreaks",
     "- R\n- Python\n- Julia"
-    )
+  )
 )
 
 tabulator(data, width = 200) |>

examples/formatters/formatter_tick_cross.R

@@ -2,7 +2,7 @@ data <- data.frame(
   Artist = c("Art Blackey", "Nirvana", "Bob Marley"),
   Grunge = c(0, 1, 0),
   Jazz = c(1, 0, 0),
-  Reggae = c(0,0,1)
+  Reggae = c(0, 0, 1)
 )
 
 tabulator(data, width = 400) |>

examples/multiple_spreadsheets.R

@@ -1,4 +1,4 @@
-options <- tabulator_options(
+setup <- tabulator_options(
   spreadsheet = TRUE,
   spreadsheet_sheets = list(
     list(
@@ -13,4 +13,4 @@ options <- tabulator_options(
   spreadsheet_sheet_tabs = TRUE
 )
 
-tabulator(data = NULL, options, theme = "midnight")
+tabulator(data = NULL, setup, theme = "midnight")

examples/tabulator_setup.R

@@ -0,0 +1,9 @@
+setup <- tabulator_options(
+  group_by = "Species",
+  pagination = TRUE,
+  pagination_size = 10,
+  pagination_size_selector = c(10, 20, 50),
+  movable_columns = TRUE,
+  movable_rows = TRUE
+)
+tabulator(iris, setup)