Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Kuethe committed Sep 20, 2024
1 parent cea07b2 commit 5d81b71
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 17 deletions.
14 changes: 8 additions & 6 deletions R/spreadsheet.R
Original file line number Diff line number Diff line change
@@ -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) {
Expand Down
13 changes: 7 additions & 6 deletions man/spreadsheet_def.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions vignettes/articles/rtabulator.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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")`

0 comments on commit 5d81b71

Please sign in to comment.