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/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/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")`