diff --git a/DESCRIPTION b/DESCRIPTION index c4268ae..0cca1e5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -22,6 +22,7 @@ License: MIT + file LICENSE Encoding: UTF-8 LazyData: true RoxygenNote: 7.3.2 +Roxygen: list(markdown = TRUE) Imports: glue, htmltools, diff --git a/R/columns.R b/R/columns.R index 458a474..c7788ad 100644 --- a/R/columns.R +++ b/R/columns.R @@ -66,12 +66,11 @@ add_filter_to_columns <- function(columns) { } #' Apply a column setter function to multiple columns -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param columns (character vector): The columns the column setter function (\code{.f}) is applied to. -#' If set to \code{NULL} it is applied to all columns. +#' If set to \code{NULL}, it is applied to all columns. #' @param .f (function): The column setter function that updates the column settings. #' @param ... Arguments that are passed to \code{.f}. -#' @returns tabulator htmlwidget #' @example examples/for_each_col.R #' @export for_each_col <- function(widget, columns = NULL, .f, ...) { @@ -90,10 +89,10 @@ for_each_col <- function(widget, columns = NULL, .f, ...) { # TODO: Move formatters to separate file #' Set HTML formatter -#' @param widget (\code{\link{tabulator}}) A tabulator widget. -#' @param column (character): The column the formatter is applied to. +#' @param widget A [tabulator()] HTML widget. +#' @param column The name of the column the formatter is applied to. #' @param hoz_align (character): The horizontal alignment of the column. -#' @returns tabulator htmlwidget +#' @returns The updated [tabulator()] HTML widget #' @example examples/formatters/formatter_html.R #' @export set_formatter_html <- function(widget, column, hoz_align = c("left", "center", "right")) { @@ -102,19 +101,19 @@ set_formatter_html <- function(widget, column, hoz_align = c("left", "center", " } #' Set plain text formatter -#' @inheritParams set_formatter_html -#' @returns tabulator htmlwidget +#' @inherit set_formatter_html params return +#' @examples +#' tabulator(iris) |> +#' set_formatter_plaintext("Species", hoz_align = "right") #' @export -# TODO: Add example set_formatter_plaintext <- function(widget, column, hoz_align = "left") { col_update <- list(formatter = "plaintext", hozAlign = hoz_align) modify_col_def(widget, column, col_update) } -#' Set textarea formatter -#' @inheritParams set_formatter_html +#' Set text area formatter +#' @inherit set_formatter_html params return #' @example examples/formatters/formatter_textarea.R -#' @returns tabulator htmlwidget #' @export set_formatter_textarea <- function(widget, column, hoz_align = "left") { col_update <- list(formatter = "textarea", hozAlign = hoz_align) @@ -122,7 +121,7 @@ set_formatter_textarea <- function(widget, column, hoz_align = "left") { } #' Set money formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param decimal (character): Symbol to represent the decimal point. #' @param thousand (character, bool): Symbol to represent the thousands separator. #' Set to \code{FALSE} to disable the separator. @@ -133,7 +132,6 @@ set_formatter_textarea <- function(widget, column, hoz_align = "left") { #' which is the standard style for negative numbers in accounting. #' @param precision (integer, bool): The number of decimals to display. #' Set to \code{FALSE} to display all decimals that are provided. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_money.R #' @export set_formatter_money <- function( @@ -163,14 +161,13 @@ set_formatter_money <- function( } #' Set image formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param height (character): A CSS value for the height of the image. #' @param width (character): A CSS value for the width of the image. #' @param url_prefix (character): String to add to the start of the cell value #' when generating the image src url. #' @param url_suffix (character): String to add to the end of the cell value #' when generating the image src url. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_image.R #' @export set_formatter_image <- function( @@ -196,14 +193,13 @@ set_formatter_image <- function( } #' Set link formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param label_field (character): Column to be used as label for the link. #' @param url_prefix (character): Prefix to add to the URL value. -#' @param url (JS function): A JS function that return the URL value. +#' @param url (JavaScript function): A JavaScript function that return the URL value. #' The cell is passed to the function as its first argument. #' Use \link[htmlwidgets]{JS} to pass JS code. #' @param target (character): Target attribute of the anchor tag. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_link.R #' @export set_formatter_link <- function( @@ -229,10 +225,9 @@ set_formatter_link <- function( } #' Set star rating formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param number_of_stars The maximum number of stars to be displayed. #' If set to \code{NA}, the maximum value of the column is used. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_star.R #' @export set_formatter_star <- function(widget, column, number_of_stars = NA, hoz_align = "center") { @@ -249,7 +244,7 @@ set_formatter_star <- function(widget, column, number_of_stars = NA, hoz_align = } #' Set progress formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param min (numeric): The minimum value for progress bar. #' If set to \code{NA}, the minimum value of the column is used. #' @param max (numeric): The maximum value for progress bar. @@ -261,7 +256,6 @@ set_formatter_star <- function(widget, column, number_of_stars = NA, hoz_align = #' In this case, the cell value is passed to the function as its first argument. #' @param legend_color (character): The text color of the legend. #' @param legend_align (character): The text alignment of the legend. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_progress.R #' @export set_formatter_progress <- function( @@ -299,9 +293,8 @@ set_formatter_progress <- function( } #' Set tick cross formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @example examples/formatters/formatter_tick_cross.R -#' @returns tabulator htmlwidget #' @export set_formatter_tick_cross <- function(widget, column, hoz_align = "center") { col_update <- list(formatter = "tickCross", hozAlign = hoz_align) @@ -309,7 +302,7 @@ set_formatter_tick_cross <- function(widget, column, hoz_align = "center") { } #' Set toggle switch formatter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param size (numeric): The size of the switch in pixels. #' @param on_value (character): The value of the cell for the switch to be on. #' @param off_value (character) The value of the cell for the switch to be off. @@ -317,7 +310,6 @@ set_formatter_tick_cross <- function(widget, column, hoz_align = "center") { #' @param on_color (character): The color of the switch if it is on. #' @param off_color (character): The color of the switch if it is off. #' @param clickable (bool): Enable switch functionality to toggle the cell value on click. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_toggle_switch.R #' @export set_formatter_toggle_switch <- function( @@ -349,15 +341,14 @@ set_formatter_toggle_switch <- function( #' Set datetime formatter #' #' @details -#' To use this formatter, you need to include the luxon html dependency -#' when creating a tabulator widget. -#' @inheritParams set_formatter_html +#' To use this formatter, you need to include +#' the [luxon](https://moment.github.io/luxon/) HTML dependency with `tabulator(..., luxon = TRUE)`. +#' @inherit set_formatter_html params return #' @param input_format (character): The datetime input format. #' @param output_format (character): The datetime output format. #' @param invalid_placeholder (character): The value to be displayed #' if an invalid datetime is provided. #' @param timezone (character): The timezone of the datetime. -#' @returns tabulator htmlwidget #' @example examples/formatters/formatter_datetime.R #' @export set_formatter_datetime <- function( @@ -383,8 +374,7 @@ set_formatter_datetime <- function( } #' Set color formatter -#' @inheritParams set_formatter_html -#' @returns tabulator htmlwidget +#' @inherit set_formatter_html params return #' @example examples/formatters/formatter_color.R #' @export set_formatter_color <- function(widget, column) { @@ -393,8 +383,7 @@ set_formatter_color <- function(widget, column) { } #' Set traffic light formatter -#' @inheritParams set_formatter_progress -#' @returns tabulator htmlwidget +#' @inherit set_formatter_progress params return #' @example examples/formatters/formatter_traffic_light.R #' @export set_formatter_traffic_light <- function( @@ -439,11 +428,10 @@ set_column_editor <- function(widget, columns, type = c("input", "number")) { } #' Set editor -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param editor (character): The editor type. #' @param validator (character vector): One or more validators to validate user input. #' @param ... Optional editor parameters depending on the selected editor. -#' @returns tabulator htmlwidget #' @seealso #' * \url{https://tabulator.info/docs/6.2/edit} for available editors #' * \url{https://tabulator.info/docs/6.2/validate} for available validators @@ -470,13 +458,12 @@ set_editor <- function( } #' Set header filter -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param type (character): The type of the filter. #' @param values_lookup (bool): Whether to use unique column values for the list filter. #' @param func (character): The filter function. #' @param clearable (bool): Whether to display a cross to clear the filter. #' @param placeholder (character): Text that is displayed when no filter is set. -#' @returns tabulator htmlwidget #' @example examples/misc/header_filter.R #' @export # TODO: Rename to params that they match params used by Tabulator JS @@ -511,8 +498,7 @@ set_header_filter <- function( } #' Set tooltip -#' @inheritParams set_formatter_html -#' @returns tabulator htmlwidget +#' @inherit set_formatter_html params return #' @example examples/misc/tooltip.R #' @export set_tooltip <- function(widget, column) { @@ -521,7 +507,7 @@ set_tooltip <- function(widget, column) { #' Set column defaults -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param editor (character, bool): One of \code{"input"} or \code{"number"}. #' If set to \code{FALSE} cells are not editable. #' @param header_filter (character, bool): One of \code{"input"} or \code{"number"}. @@ -530,7 +516,6 @@ set_tooltip <- function(widget, column) { #' @param tooltip (bool): Whether to show tooltips displaying the cell value. #' @param width (integer): Fixed width of columns. #' @param ... Additional settings. -#' @returns tabulator htmlwidget #' @seealso \url{https://tabulator.info/docs/6.2/columns#defaults} #' @example examples/column_defaults.R #' @export @@ -555,14 +540,13 @@ set_column_defaults <- function( } #' Set calculation -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param column (character): The column the \code{func} is applied to. #' @param func (character): The calculation function to be applied #' to the values of the \code{column}. #' @param precision (integer) The number of decimals to display. #' Set to \code{FALSE} to display all decimals. #' @param pos (character): Position at which calculated values are displayed. -#' @returns tabulator htmlwidget #' @example examples/data_url.R #' @export set_calculation <- function( diff --git a/R/context_calls.R b/R/context_calls.R index 3036350..9eefdf5 100644 --- a/R/context_calls.R +++ b/R/context_calls.R @@ -1,13 +1,12 @@ #' Download table data #' #' @details -#' If you want to provide xlsx downloads, you need to include -#' the sheetjs html dependency: \code{tabulator(..., sheetjs = TRUE)} -#' @param ctx (\code{\link{tabulatorContext}}): tabulator context object -#' @param type (character): csv, json or xlsx -#' @param file_name (character, \code{NULL}): File name. -#' If \code{NULL}, it is set to \code{"data.{type}"}. -#' @returns tabulator context object +#' If you want to support `xlsx` downloads, you need to include +#' the [sheetjs](https://sheetjs.com/) HTML dependency with `tabulator(..., sheetjs = TRUE)`. +#' @param ctx A [tabulatorContext()] object. +#' @param type File format. +#' @param file_name File name. Set to `"data.{type}"` if `file_name = NULL`. +#' @returns A [tabulatorContext()] object #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -23,8 +22,7 @@ trigger_download <- function(ctx, type = c("csv", "json", "xlsx"), file_name = N } #' Submit data to R -#' @inheritParams trigger_download -#' @returns tabulator context object +#' @inherit trigger_download params return #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -36,9 +34,8 @@ trigger_get_data <- function(ctx) { } #' Add row to table -#' @inheritParams trigger_download +#' @inherit trigger_download params return #' @param row (list): row data or \code{NULL} to add an empty row -#' @returns tabulator context object #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -50,8 +47,7 @@ add_row <- function(ctx, row = NULL) { } #' Delete selected rows from table -#' @inheritParams trigger_download -#' @returns tabulator context object +#' @inherit trigger_download params return #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -69,8 +65,7 @@ delete_row <- function(ctx) { } #' Undo changes -#' @inheritParams trigger_download -#' @returns tabulator context object +#' @inherit trigger_download params return #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -82,8 +77,7 @@ undo <- function(ctx) { } #' Redo changes -#' @inheritParams trigger_download -#' @returns tabulator context object +#' @inherit trigger_download params return #' @examples #' \dontrun{ #' tabulatorContext("table") |> @@ -95,8 +89,7 @@ redo <- function(ctx) { } #' Submit sheet data to R -#' @inheritParams trigger_download -#' @returns tabulator context object +#' @inherit trigger_download params return #' @examples #' \dontrun{ #' tabulatorContext("table") |> diff --git a/R/experimental.R b/R/experimental.R index c31907f..ef35341 100644 --- a/R/experimental.R +++ b/R/experimental.R @@ -1,8 +1,7 @@ # See example here: https://github.com/eodaGmbH/py-tabulator/blob/main/docs/examples/getting_started/shiny_core_multi_row_headers.py #' Set multi column header -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @param multi_columns (list): Multi column definitions. -#' @returns tabulator htmlwidget #' @example examples/experimental/multi_column_header.R #' @export set_multi_column_header <- function(widget, multi_columns) { @@ -46,3 +45,10 @@ get_theme_dependeny <- function( all_files = FALSE ) } + +# ----- +# #' Test docs +# #' @inherit set_formatter_html params return +test_column_func <- function(widget, column) { + return(widget) +} diff --git a/R/spreadsheet.R b/R/spreadsheet.R index b112e4f..ce847b8 100644 --- a/R/spreadsheet.R +++ b/R/spreadsheet.R @@ -1,9 +1,11 @@ -#' Create a spreadsheet definition -#' @param title (character): The name of the spreadsheet. -#' @param key (character): Optional unique key of the spreadsheet. -#' @param data (list): The initial data of the spreadsheet. -#' Set to \code{NULL} to create an empty spreadsheet. -#' @returns list +#' Spreadsheet definition for `tabulator()` HTML widget +#' +#' @param title Name of the spreadsheet. +#' @param key Unique key of the spreadsheet. +#' @param data Initial data of the spreadsheet. +#' Set to `NULL` to create an empty spreadsheet. +#' @returns list with spreadsheet options to be used as a sheet of the +#' `spreadsheet_sheets` parameter in [tabulator_options()] #' @example examples/multiple_spreadsheets.R #' @export spreadsheet_def <- function(title, key = NULL, data = NULL) { diff --git a/R/tabulator.R b/R/tabulator.R index fe03523..5d6944c 100644 --- a/R/tabulator.R +++ b/R/tabulator.R @@ -1,23 +1,22 @@ -#' Create a tabulator widget +#' HTML widget to work with tabular data #' #' @details #' Dots in column names are replaced by underscores. #' @param data (data.frame, character or list): In spreadsheet mode data needs to be a list or \code{NULL} #' for an empty spreadsheet. -#' @param options (list): Setup options. See \code{\link{tabulator_options}}. -#' @param editable (bool): Whether the table is editable. -#' @param luxon (bool): Whether to add \href{https://moment.github.io/luxon/}{luxon} dependency, -#' which is required for \code{\link{set_formatter_datetime}}. -#' @param sheetjs (bool): Whether to add \href{https://sheetjs.com/}{sheetjs} dependency, -#' which is required for \code{\link{trigger_download}} to support Excel type downloads. -#' @param theme (character): Theme to apply to the table. -#' @param col_select (character vector) Columns to select. -#' Passed to \code{\link[readr]{read_csv}} if \code{data} is a file name. -#' @param width Width of the widget. -#' @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. -#' @returns tabulator htmlwidget +#' @param options List of setup options. Defaults to [tabulator_options()]. +#' @param editable Whether the table is editable. +#' @param luxon Whether to add [luxon](https://moment.github.io/luxon/) HTML dependency, +#' which is required for [set_formatter_datetime()]. +#' @param sheetjs Whether to add [sheetjs](https://sheetjs.com/) HTML dependency, +#' which is required for [trigger_download()] to support downloads of `xlsx` files. +#' @param theme Name of the theme to be applied to the table. +#' @param col_select Passed to [readr::read_csv()] if `data` is a file name. +#' @param width,height Output size. +#' @param element_id Unique ID of the widget element. +#' @param ... Named arguments that are appended to the `options` parameter. +#' @seealso [tabulatorOutput()] for use within Shiny apps +#' @returns A HTML widget #' @example examples/multiple_spreadsheets.R #' @import htmlwidgets #' @export @@ -103,7 +102,7 @@ tabulator <- function( #' @param env The environment in which to evaluate \code{expr}. #' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This #' is useful if you want to save an expression in a variable. -#' +#' @returns Components for use inside a Shiny app. #' @name rtabulator-shiny #' #' @export diff --git a/R/tabulator_context.R b/R/tabulator_context.R index 97d9002..d2ec1f8 100644 --- a/R/tabulator_context.R +++ b/R/tabulator_context.R @@ -14,13 +14,13 @@ invoke_method <- function(widget, method_name, ...) { invisible(widget) } -#' Create a tabulator context object +#' Context object to update a `tabulator()` HTML widget #' #' @details -#' A \code{tabulatorContext} object makes it possible to update your widget in a Shiny application. -#' @param output_id (character): A tabulator output id. +#' Makes it possible to update your [tabulator()] HTML widget in Shiny apps. +#' @param output_id A tabulator output id set with [tabulatorOutput()]. #' @param session A shiny session object. -#' @returns tabulator context object +#' @returns A context object that can be used to interact with a [tabulator()] HTML widget #' @examples #' \dontrun{ #' tabulatorContext("table") |> diff --git a/R/tabulator_options.R b/R/tabulator_options.R index 4f76e7b..d6e7251 100644 --- a/R/tabulator_options.R +++ b/R/tabulator_options.R @@ -1,5 +1,6 @@ -#' Create a tabulator options object -#' @param height (character) The height of the table in px. +#' Setup options for `tabulator()` HTML widget +#' +#' @param height (character) The height of the table in pixels. #' @param history (bool): Enable user interaction history functionality. #' @param columns (list): Column definitions. #' If set to \code{NULL}, definitions are auto generated from table data. @@ -36,8 +37,8 @@ #' @param spreadsheet_sheets (list): List of sheet definitions. #' @param spreadsheet_sheet_tabs (bool): Whether to show sheet tabs in the footer. #' @param ... Further options. -#' @returns list -#' @seealso \url{https://tabulator.info/docs/6.2/options} +#' @returns list with setup options to be used as `options` parameter in [tabulator()] +#' @seealso \url{https://tabulator.info/docs/6.2/options} for a complete list of available options #' @example examples/tabulator_setup.R #' @export tabulator_options <- function( @@ -105,9 +106,8 @@ default_spreadsheet_options <- list( ) #' Set pagination options -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @inheritParams tabulator_options -#' @returns tabulator htmlwidget #' @example examples/options/pagination_options.R #' @export set_options_pagination <- function( @@ -129,9 +129,8 @@ set_options_pagination <- function( } #' Set group by options -#' @inheritParams set_formatter_html +#' @inherit set_formatter_html params return #' @inheritParams tabulator_options -#' @returns tabulator htmlwidget #' @example examples/options/group_by_options.R #' @export set_options_group_by <- function( diff --git a/examples/formatters/formatter_datetime.R b/examples/formatters/formatter_datetime.R index 1ec37e5..7198fd9 100644 --- a/examples/formatters/formatter_datetime.R +++ b/examples/formatters/formatter_datetime.R @@ -6,5 +6,5 @@ data <- data.frame( ) ) -tabulator(data) |> +tabulator(data, luxon = TRUE) |> set_formatter_datetime("Birthday", output_format = "dd.MM.yyyy") diff --git a/man/add_row.Rd b/man/add_row.Rd index 76421d3..696ad78 100644 --- a/man/add_row.Rd +++ b/man/add_row.Rd @@ -7,12 +7,12 @@ add_row(ctx, row = NULL) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} \item{row}{(list): row data or \code{NULL} to add an empty row} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Add row to table diff --git a/man/delete_selected_rows.Rd b/man/delete_selected_rows.Rd index ba8d8e0..5876910 100644 --- a/man/delete_selected_rows.Rd +++ b/man/delete_selected_rows.Rd @@ -7,10 +7,10 @@ delete_selected_rows(ctx) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Delete selected rows from table diff --git a/man/for_each_col.Rd b/man/for_each_col.Rd index 5db3755..afb8554 100644 --- a/man/for_each_col.Rd +++ b/man/for_each_col.Rd @@ -7,17 +7,17 @@ for_each_col(widget, columns = NULL, .f, ...) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{columns}{(character vector): The columns the column setter function (\code{.f}) is applied to. -If set to \code{NULL} it is applied to all columns.} +If set to \code{NULL}, it is applied to all columns.} \item{.f}{(function): The column setter function that updates the column settings.} \item{...}{Arguments that are passed to \code{.f}.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Apply a column setter function to multiple columns diff --git a/man/redo.Rd b/man/redo.Rd index 6b420b2..a56a0a1 100644 --- a/man/redo.Rd +++ b/man/redo.Rd @@ -7,10 +7,10 @@ redo(ctx) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Redo changes diff --git a/man/rtabulator-shiny.Rd b/man/rtabulator-shiny.Rd index 2310024..c2a61de 100644 --- a/man/rtabulator-shiny.Rd +++ b/man/rtabulator-shiny.Rd @@ -24,6 +24,9 @@ string and have \code{'px'} appended.} \item{quoted}{Is \code{expr} a quoted expression (with \code{quote()})? This is useful if you want to save an expression in a variable.} } +\value{ +Components for use inside a Shiny app. +} \description{ Output and render functions for using rtabulator within Shiny applications and interactive Rmd documents. diff --git a/man/set_calculation.Rd b/man/set_calculation.Rd index 8722a2c..ae726a1 100644 --- a/man/set_calculation.Rd +++ b/man/set_calculation.Rd @@ -13,7 +13,7 @@ set_calculation( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{column}{(character): The column the \code{func} is applied to.} @@ -26,7 +26,7 @@ Set to \code{FALSE} to display all decimals.} \item{pos}{(character): Position at which calculated values are displayed.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set calculation diff --git a/man/set_column_defaults.Rd b/man/set_column_defaults.Rd index 4e37437..e3753ef 100644 --- a/man/set_column_defaults.Rd +++ b/man/set_column_defaults.Rd @@ -15,7 +15,7 @@ set_column_defaults( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{editor}{(character, bool): One of \code{"input"} or \code{"number"}. If set to \code{FALSE} cells are not editable.} @@ -32,7 +32,7 @@ Set to \code{FALSE} to disable header filters.} \item{...}{Additional settings.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set column defaults diff --git a/man/set_editor.Rd b/man/set_editor.Rd index 08ffdfd..255c42c 100644 --- a/man/set_editor.Rd +++ b/man/set_editor.Rd @@ -14,9 +14,9 @@ set_editor( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{editor}{(character): The editor type.} @@ -25,7 +25,7 @@ set_editor( \item{...}{Optional editor parameters depending on the selected editor.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set editor diff --git a/man/set_formatter_color.Rd b/man/set_formatter_color.Rd index 8c4c5b3..4377b50 100644 --- a/man/set_formatter_color.Rd +++ b/man/set_formatter_color.Rd @@ -7,12 +7,12 @@ set_formatter_color(widget, column) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set color formatter diff --git a/man/set_formatter_datetime.Rd b/man/set_formatter_datetime.Rd index 5831573..848bfa7 100644 --- a/man/set_formatter_datetime.Rd +++ b/man/set_formatter_datetime.Rd @@ -15,9 +15,9 @@ set_formatter_datetime( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{input_format}{(character): The datetime input format.} @@ -31,14 +31,14 @@ if an invalid datetime is provided.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set datetime formatter } \details{ -To use this formatter, you need to include the luxon html dependency -when creating a tabulator widget. +To use this formatter, you need to include +the \href{https://moment.github.io/luxon/}{luxon} HTML dependency with \code{tabulator(..., luxon = TRUE)}. } \examples{ data <- data.frame( @@ -49,6 +49,6 @@ data <- data.frame( ) ) -tabulator(data) |> +tabulator(data, luxon = TRUE) |> set_formatter_datetime("Birthday", output_format = "dd.MM.yyyy") } diff --git a/man/set_formatter_html.Rd b/man/set_formatter_html.Rd index a8d3c4d..cdec68e 100644 --- a/man/set_formatter_html.Rd +++ b/man/set_formatter_html.Rd @@ -7,14 +7,14 @@ set_formatter_html(widget, column, hoz_align = c("left", "center", "right")) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set HTML formatter diff --git a/man/set_formatter_image.Rd b/man/set_formatter_image.Rd index a99fcb8..2d4fa79 100644 --- a/man/set_formatter_image.Rd +++ b/man/set_formatter_image.Rd @@ -15,9 +15,9 @@ set_formatter_image( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{height}{(character): A CSS value for the height of the image.} @@ -32,7 +32,7 @@ when generating the image src url.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set image formatter diff --git a/man/set_formatter_link.Rd b/man/set_formatter_link.Rd index 0f5f3ef..1af240a 100644 --- a/man/set_formatter_link.Rd +++ b/man/set_formatter_link.Rd @@ -15,15 +15,15 @@ set_formatter_link( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{label_field}{(character): Column to be used as label for the link.} \item{url_prefix}{(character): Prefix to add to the URL value.} -\item{url}{(JS function): A JS function that return the URL value. +\item{url}{(JavaScript function): A JavaScript function that return the URL value. The cell is passed to the function as its first argument. Use \link[htmlwidgets]{JS} to pass JS code.} @@ -32,7 +32,7 @@ Use \link[htmlwidgets]{JS} to pass JS code.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set link formatter diff --git a/man/set_formatter_money.Rd b/man/set_formatter_money.Rd index 77a3649..8594ca1 100644 --- a/man/set_formatter_money.Rd +++ b/man/set_formatter_money.Rd @@ -17,9 +17,9 @@ set_formatter_money( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{decimal}{(character): Symbol to represent the decimal point.} @@ -40,7 +40,7 @@ Set to \code{FALSE} to display all decimals that are provided.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set money formatter diff --git a/man/set_formatter_plaintext.Rd b/man/set_formatter_plaintext.Rd index 07f887c..8c9b53d 100644 --- a/man/set_formatter_plaintext.Rd +++ b/man/set_formatter_plaintext.Rd @@ -7,15 +7,19 @@ set_formatter_plaintext(widget, column, hoz_align = "left") } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set plain text formatter } +\examples{ +tabulator(iris) |> + set_formatter_plaintext("Species", hoz_align = "right") +} diff --git a/man/set_formatter_progress.Rd b/man/set_formatter_progress.Rd index 52796aa..3f1afc8 100644 --- a/man/set_formatter_progress.Rd +++ b/man/set_formatter_progress.Rd @@ -17,9 +17,9 @@ set_formatter_progress( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{min}{(numeric): The minimum value for progress bar. If set to \code{NA}, the minimum value of the column is used.} @@ -41,7 +41,7 @@ In this case, the cell value is passed to the function as its first argument.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set progress formatter diff --git a/man/set_formatter_star.Rd b/man/set_formatter_star.Rd index 538891f..0d44886 100644 --- a/man/set_formatter_star.Rd +++ b/man/set_formatter_star.Rd @@ -7,9 +7,9 @@ set_formatter_star(widget, column, number_of_stars = NA, hoz_align = "center") } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{number_of_stars}{The maximum number of stars to be displayed. If set to \code{NA}, the maximum value of the column is used.} @@ -17,7 +17,7 @@ If set to \code{NA}, the maximum value of the column is used.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set star rating formatter diff --git a/man/set_formatter_textarea.Rd b/man/set_formatter_textarea.Rd index 1130fbe..075103b 100644 --- a/man/set_formatter_textarea.Rd +++ b/man/set_formatter_textarea.Rd @@ -2,22 +2,22 @@ % Please edit documentation in R/columns.R \name{set_formatter_textarea} \alias{set_formatter_textarea} -\title{Set textarea formatter} +\title{Set text area formatter} \usage{ set_formatter_textarea(widget, column, hoz_align = "left") } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ -Set textarea formatter +Set text area formatter } \examples{ data <- data.frame( diff --git a/man/set_formatter_tick_cross.Rd b/man/set_formatter_tick_cross.Rd index 25a75a1..2c39479 100644 --- a/man/set_formatter_tick_cross.Rd +++ b/man/set_formatter_tick_cross.Rd @@ -7,14 +7,14 @@ set_formatter_tick_cross(widget, column, hoz_align = "center") } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set tick cross formatter diff --git a/man/set_formatter_toggle_switch.Rd b/man/set_formatter_toggle_switch.Rd index 5cd7563..c8350a0 100644 --- a/man/set_formatter_toggle_switch.Rd +++ b/man/set_formatter_toggle_switch.Rd @@ -17,9 +17,9 @@ set_formatter_toggle_switch( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{size}{(numeric): The size of the switch in pixels.} @@ -36,7 +36,7 @@ set_formatter_toggle_switch( \item{clickable}{(bool): Enable switch functionality to toggle the cell value on click.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set toggle switch formatter diff --git a/man/set_formatter_traffic_light.Rd b/man/set_formatter_traffic_light.Rd index 09a45e4..f2592c4 100644 --- a/man/set_formatter_traffic_light.Rd +++ b/man/set_formatter_traffic_light.Rd @@ -14,9 +14,9 @@ set_formatter_traffic_light( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{min}{(numeric): The minimum value for progress bar. If set to \code{NA}, the minimum value of the column is used.} @@ -29,7 +29,7 @@ If set to \code{NA}, the maximum value of the column is used.} \item{hoz_align}{(character): The horizontal alignment of the column.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set traffic light formatter diff --git a/man/set_header_filter.Rd b/man/set_header_filter.Rd index 18639b8..9131b4a 100644 --- a/man/set_header_filter.Rd +++ b/man/set_header_filter.Rd @@ -15,9 +15,9 @@ set_header_filter( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} \item{type}{(character): The type of the filter.} @@ -30,7 +30,7 @@ set_header_filter( \item{placeholder}{(character): Text that is displayed when no filter is set.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set header filter diff --git a/man/set_multi_column_header.Rd b/man/set_multi_column_header.Rd index d89fec1..9e69464 100644 --- a/man/set_multi_column_header.Rd +++ b/man/set_multi_column_header.Rd @@ -7,12 +7,12 @@ set_multi_column_header(widget, multi_columns) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{multi_columns}{(list): Multi column definitions.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set multi column header diff --git a/man/set_options_group_by.Rd b/man/set_options_group_by.Rd index e31fac4..a41fa92 100644 --- a/man/set_options_group_by.Rd +++ b/man/set_options_group_by.Rd @@ -13,7 +13,7 @@ set_options_group_by( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{group_by}{(character vector): Field to group rows by. Pass multiple values for multi level grouping.} @@ -27,7 +27,7 @@ Set to \code{FALSE} to disable toggling at all.} \item{...}{Further options.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set group by options diff --git a/man/set_options_pagination.Rd b/man/set_options_pagination.Rd index ca369cf..56de81d 100644 --- a/man/set_options_pagination.Rd +++ b/man/set_options_pagination.Rd @@ -14,7 +14,7 @@ set_options_pagination( ) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} \item{pagination}{(bool): Whether to enable pagination.} @@ -27,7 +27,7 @@ set_options_pagination( \item{...}{Further options.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set pagination options diff --git a/man/set_tooltip.Rd b/man/set_tooltip.Rd index 5ce5661..80a530c 100644 --- a/man/set_tooltip.Rd +++ b/man/set_tooltip.Rd @@ -7,12 +7,12 @@ set_tooltip(widget, column) } \arguments{ -\item{widget}{(\code{\link{tabulator}}) A tabulator widget.} +\item{widget}{A \code{\link[=tabulator]{tabulator()}} HTML widget.} -\item{column}{(character): The column the formatter is applied to.} +\item{column}{The name of the column the formatter is applied to.} } \value{ -tabulator htmlwidget +The updated \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ Set tooltip diff --git a/man/spreadsheet_def.Rd b/man/spreadsheet_def.Rd index e8e9772..28b1593 100644 --- a/man/spreadsheet_def.Rd +++ b/man/spreadsheet_def.Rd @@ -2,23 +2,24 @@ % Please edit documentation in R/spreadsheet.R \name{spreadsheet_def} \alias{spreadsheet_def} -\title{Create a spreadsheet definition} +\title{Spreadsheet definition for \code{tabulator()} HTML widget} \usage{ spreadsheet_def(title, key = NULL, data = NULL) } \arguments{ -\item{title}{(character): The name of the spreadsheet.} +\item{title}{Name of the spreadsheet.} -\item{key}{(character): Optional unique key of the spreadsheet.} +\item{key}{Unique key of the spreadsheet.} -\item{data}{(list): The initial data of the spreadsheet. +\item{data}{Initial data of the spreadsheet. Set to \code{NULL} to create an empty spreadsheet.} } \value{ -list +list with spreadsheet options to be used as a sheet of the +\code{spreadsheet_sheets} parameter in \code{\link[=tabulator_options]{tabulator_options()}} } \description{ -Create a spreadsheet definition +Spreadsheet definition for \code{tabulator()} HTML widget } \examples{ setup <- tabulator_options( diff --git a/man/tabulator.Rd b/man/tabulator.Rd index b94b550..e6a27c2 100644 --- a/man/tabulator.Rd +++ b/man/tabulator.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/tabulator.R \name{tabulator} \alias{tabulator} -\title{Create a tabulator widget} +\title{HTML widget to work with tabular data} \usage{ tabulator( data, @@ -23,34 +23,31 @@ tabulator( \item{data}{(data.frame, character or list): In spreadsheet mode data needs to be a list or \code{NULL} for an empty spreadsheet.} -\item{options}{(list): Setup options. See \code{\link{tabulator_options}}.} +\item{options}{List of setup options. Defaults to \code{\link[=tabulator_options]{tabulator_options()}}.} -\item{editable}{(bool): Whether the table is editable.} +\item{editable}{Whether the table is editable.} -\item{luxon}{(bool): Whether to add \href{https://moment.github.io/luxon/}{luxon} dependency, -which is required for \code{\link{set_formatter_datetime}}.} +\item{luxon}{Whether to add \href{https://moment.github.io/luxon/}{luxon} HTML dependency, +which is required for \code{\link[=set_formatter_datetime]{set_formatter_datetime()}}.} -\item{sheetjs}{(bool): Whether to add \href{https://sheetjs.com/}{sheetjs} dependency, -which is required for \code{\link{trigger_download}} to support Excel type downloads.} +\item{sheetjs}{Whether to add \href{https://sheetjs.com/}{sheetjs} HTML dependency, +which is required for \code{\link[=trigger_download]{trigger_download()}} to support downloads of \code{xlsx} files.} -\item{theme}{(character): Theme to apply to the table.} +\item{theme}{Name of the theme to be applied to the table.} -\item{col_select}{(character vector) Columns to select. -Passed to \code{\link[readr]{read_csv}} if \code{data} is a file name.} +\item{col_select}{Passed to \code{\link[readr:read_delim]{readr::read_csv()}} if \code{data} is a file name.} -\item{width}{Width of the widget.} +\item{width, height}{Output size.} -\item{height}{Height of the widget.} - -\item{element_id}{The unique ID of the widget.} +\item{element_id}{Unique ID of the widget element.} \item{...}{Named arguments that are appended to the \code{options} parameter.} } \value{ -tabulator htmlwidget +A HTML widget } \description{ -Create a tabulator widget +HTML widget to work with tabular data } \details{ Dots in column names are replaced by underscores. @@ -73,3 +70,6 @@ setup <- tabulator_options( tabulator(data = NULL, setup, theme = "midnight") } +\seealso{ +\code{\link[=tabulatorOutput]{tabulatorOutput()}} for use within Shiny apps +} diff --git a/man/tabulatorContext.Rd b/man/tabulatorContext.Rd index 314a50d..e4ca6e1 100644 --- a/man/tabulatorContext.Rd +++ b/man/tabulatorContext.Rd @@ -2,23 +2,23 @@ % Please edit documentation in R/tabulator_context.R \name{tabulatorContext} \alias{tabulatorContext} -\title{Create a tabulator context object} +\title{Context object to update a \code{tabulator()} HTML widget} \usage{ tabulatorContext(output_id, session = shiny::getDefaultReactiveDomain()) } \arguments{ -\item{output_id}{(character): A tabulator output id.} +\item{output_id}{A tabulator output id set with \code{\link[=tabulatorOutput]{tabulatorOutput()}}.} \item{session}{A shiny session object.} } \value{ -tabulator context object +A context object that can be used to interact with a \code{\link[=tabulator]{tabulator()}} HTML widget } \description{ -Create a tabulator context object +Context object to update a \code{tabulator()} HTML widget } \details{ -A \code{tabulatorContext} object makes it possible to update your widget in a Shiny application. +Makes it possible to update your \code{\link[=tabulator]{tabulator()}} HTML widget in Shiny apps. } \examples{ \dontrun{ diff --git a/man/tabulator_options.Rd b/man/tabulator_options.Rd index 3d5eb4d..6b8e390 100644 --- a/man/tabulator_options.Rd +++ b/man/tabulator_options.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/tabulator_options.R \name{tabulator_options} \alias{tabulator_options} -\title{Create a tabulator options object} +\title{Setup options for \code{tabulator()} HTML widget} \usage{ tabulator_options( height = "311px", @@ -37,7 +37,7 @@ tabulator_options( ) } \arguments{ -\item{height}{(character) The height of the table in px.} +\item{height}{(character) The height of the table in pixels.} \item{history}{(bool): Enable user interaction history functionality.} @@ -104,10 +104,10 @@ An integer value sets the maximum number of rows that can be selected.} \item{...}{Further options.} } \value{ -list +list with setup options to be used as \code{options} parameter in \code{\link[=tabulator]{tabulator()}} } \description{ -Create a tabulator options object +Setup options for \code{tabulator()} HTML widget } \examples{ setup <- tabulator_options( @@ -121,5 +121,5 @@ setup <- tabulator_options( tabulator(iris, setup) } \seealso{ -\url{https://tabulator.info/docs/6.2/options} +\url{https://tabulator.info/docs/6.2/options} for a complete list of available options } diff --git a/man/trigger_download.Rd b/man/trigger_download.Rd index a12f26a..dbdf140 100644 --- a/man/trigger_download.Rd +++ b/man/trigger_download.Rd @@ -7,22 +7,21 @@ trigger_download(ctx, type = c("csv", "json", "xlsx"), file_name = NULL) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} -\item{type}{(character): csv, json or xlsx} +\item{type}{File format.} -\item{file_name}{(character, \code{NULL}): File name. -If \code{NULL}, it is set to \code{"data.{type}"}.} +\item{file_name}{File name. Set to \code{"data.{type}"} if \code{file_name = NULL}.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Download table data } \details{ -If you want to provide xlsx downloads, you need to include -the sheetjs html dependency: \code{tabulator(..., sheetjs = TRUE)} +If you want to support \code{xlsx} downloads, you need to include +the \href{https://sheetjs.com/}{sheetjs} HTML dependency with \code{tabulator(..., sheetjs = TRUE)}. } \examples{ \dontrun{ diff --git a/man/trigger_get_data.Rd b/man/trigger_get_data.Rd index 5fa9726..dd4ad38 100644 --- a/man/trigger_get_data.Rd +++ b/man/trigger_get_data.Rd @@ -7,10 +7,10 @@ trigger_get_data(ctx) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Submit data to R diff --git a/man/trigger_get_sheet_data.Rd b/man/trigger_get_sheet_data.Rd index 76f9ab8..7731082 100644 --- a/man/trigger_get_sheet_data.Rd +++ b/man/trigger_get_sheet_data.Rd @@ -7,10 +7,10 @@ trigger_get_sheet_data(ctx) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Submit sheet data to R diff --git a/man/undo.Rd b/man/undo.Rd index ecddf25..cbb938b 100644 --- a/man/undo.Rd +++ b/man/undo.Rd @@ -7,10 +7,10 @@ undo(ctx) } \arguments{ -\item{ctx}{(\code{\link{tabulatorContext}}): tabulator context object} +\item{ctx}{A \code{\link[=tabulatorContext]{tabulatorContext()}} object.} } \value{ -tabulator context object +A \code{\link[=tabulatorContext]{tabulatorContext()}} object } \description{ Undo changes diff --git a/vignettes/articles/rtabulator.Rmd b/vignettes/articles/rtabulator.Rmd index 1768c8a..3257a15 100644 --- a/vignettes/articles/rtabulator.Rmd +++ b/vignettes/articles/rtabulator.Rmd @@ -233,9 +233,8 @@ setup <- tabulator_options( tabulator(NULL, setup) ``` -## How to learn more +## Learn more -* [API reference](../reference/index.html) -* [Shiny integration](../articles/shiny.html) -* [Themes](../articles/themes.html) -* [Connecting tables](../articles/connected-tables.html) +* Shiny integration: `vignette("shiny")` +* Themes: `vignette("themes")` +* Connecting tables: `vignette("connected-tables")`