From f28a8bfd8f7833d26d764f5fb544a4ec1bc6fc71 Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Thu, 23 Nov 2023 08:57:23 +0100 Subject: [PATCH] chore: Resolve CRAN review comments. --- .Rbuildignore | 2 ++ DESCRIPTION | 4 ++-- R/inputs.R | 9 +++++++++ R/tooltip.R | 2 ++ cran-comments.md | 36 ++++++++++++++++++++++++++++++++++++ inst/WORDLIST | 1 + man/button_extra.Rd | 4 +++- man/checkbox_extra.Rd | 3 +++ man/date_extra.Rd | 3 +++ man/dropdown_extra.Rd | 3 +++ man/text_extra.Rd | 3 +++ man/tooltip_extra.Rd | 3 +++ 12 files changed, 70 insertions(+), 3 deletions(-) create mode 100644 cran-comments.md diff --git a/.Rbuildignore b/.Rbuildignore index d2c3056..52a0265 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,5 @@ vignettes pkgdown _\.new\.png$ ^e2e_tests$ +^CRAN-SUBMISSION$ +^cran-comments\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index ad8597c..728f556 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,8 +11,8 @@ Authors@R: person("Eduardo", "Almeida", role = c("ctb"), email = "eduardo@appsilon.com"), person("Appsilon Sp. z o.o.", role = "cph", email = "opensource@appsilon.com") ) -Description: Enhanced functionality for 'reactable' in 'Shiny' applications, offering interactive and dynamic data table capabilities with ease. - With 'reactable.extras', easily integrate a range of functions and components to enrich your 'Shiny' apps and facilitate user-friendly data exploration. +Description: Enhanced functionality for 'reactable' in 'shiny' applications, offering interactive and dynamic data table capabilities with ease. + With 'reactable.extras', easily integrate a range of functions and components to enrich your 'shiny' apps and facilitate user-friendly data exploration. License: LGPL-3 URL: https://appsilon.github.io/reactable.extras/, https://github.com/Appsilon/reactable.extras BugReports: https://github.com/Appsilon/reactable.extras/issues diff --git a/R/inputs.R b/R/inputs.R index 166ca5c..7a9ae40 100644 --- a/R/inputs.R +++ b/R/inputs.R @@ -44,6 +44,7 @@ define_key <- function(key) { #' @examples #' reactable::colDef(cell = button_extra("click", class = "table-button")) #' +#' @return Custom JS button renderer for reactable #' #' @export button_extra <- function(id, key = NULL, ...) { @@ -73,6 +74,8 @@ button_extra <- function(id, key = NULL, ...) { #' @examples #' reactable::colDef(cell = checkbox_extra("check", class = "table-check")) #' +#' @return Custom JS checkbox renderer for reactable +#' #' @export checkbox_extra <- function(id, key = NULL, ...) { key <- define_key(key) @@ -101,6 +104,8 @@ checkbox_extra <- function(id, key = NULL, ...) { #' @examples #' reactable::colDef(cell = date_extra("date", class = "table-date")) #' +#' @return Custom JS date input renderer for reactable +#' #' @export date_extra <- function(id, key = NULL, ...) { key <- define_key(key) @@ -145,6 +150,8 @@ build_dropdown_extra_choices <- function(choices) { #' ) #' ) #' +#' @return Custom JS dropdown renderer for reactable +#' #' @export dropdown_extra <- function(id, choices, key = NULL, ...) { @@ -177,6 +184,8 @@ dropdown_extra <- function(id, choices, key = NULL, ...) { #' #' @examples #' reactable::colDef(cell = text_extra("text", class = "table-text")) +##' +#' @return Custom JS text input renderer for reactable #' #' @export text_extra <- function(id, key = NULL, ...) { diff --git a/R/tooltip.R b/R/tooltip.R index ff5e6f3..5c1a473 100644 --- a/R/tooltip.R +++ b/R/tooltip.R @@ -7,6 +7,8 @@ #' @examples #' reactable::colDef(header = tooltip_extra("This is my tool-tip", theme = "material")) #' +#' @return Custom JS tool-tip renderer for reactable +#' #' @export tooltip_extra <- function(content, theme = "light") { reactable::JS( diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..ea3d668 --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,36 @@ +# Resubmission + +> Please note that package names are case sensitive. 'Shiny' --> 'shiny' + +We changed the case. + +> If there are references describing the methods in your package, please +add these in the description field of your DESCRIPTION file in the form +authors (year) +authors (year) +authors (year, ISBN:...) +or if those are not available: +with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for +auto-linking. +(If you want to add a title as well please put it in quotes: "Title") + +Unfortunately, there are no references to include regarding this package. + +> Please add \value to .Rd files regarding exported methods and explain +the functions results in the documentation. Please write about the +structure of the output (class) and also what the output means. (If a +function does not return a value, please document that too, e.g. +\value{No return value, called for side effects} or similar) + Missing Rd-tags: + button_extra.Rd: \value + checkbox_extra.Rd: \value + date_extra.Rd: \value + dropdown_extra.Rd: \value + text_extra.Rd: \value + tooltip_extra.Rd: \value + +## R CMD check results + +0 errors | 0 warnings | 1 note + +* This is a new release. diff --git a/inst/WORDLIST b/inst/WORDLIST index d24d9b0..7490bde 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -12,3 +12,4 @@ reactable customizable Codecov tooltips +renderer diff --git a/man/button_extra.Rd b/man/button_extra.Rd index 76677c0..4a77287 100644 --- a/man/button_extra.Rd +++ b/man/button_extra.Rd @@ -13,11 +13,13 @@ button_extra(id, key = NULL, ...) \item{...}{parameters of button, only \code{class} is supported for now} } +\value{ +Custom JS button renderer for reactable +} \description{ Button input for reactable column cell } \examples{ reactable::colDef(cell = button_extra("click", class = "table-button")) - } diff --git a/man/checkbox_extra.Rd b/man/checkbox_extra.Rd index 9558cdf..8f9b2a8 100644 --- a/man/checkbox_extra.Rd +++ b/man/checkbox_extra.Rd @@ -13,6 +13,9 @@ checkbox_extra(id, key = NULL, ...) \item{...}{parameters of checkbox, only \code{class} is supported for now} } +\value{ +Custom JS checkbox renderer for reactable +} \description{ Checkbox input for reactable column cell } diff --git a/man/date_extra.Rd b/man/date_extra.Rd index 00ee4aa..69648ff 100644 --- a/man/date_extra.Rd +++ b/man/date_extra.Rd @@ -13,6 +13,9 @@ date_extra(id, key = NULL, ...) \item{...}{parameters of date input, only \code{class} is supported for now} } +\value{ +Custom JS date input renderer for reactable +} \description{ Date input for reactable column cell } diff --git a/man/dropdown_extra.Rd b/man/dropdown_extra.Rd index 11b3c30..cfcc26e 100644 --- a/man/dropdown_extra.Rd +++ b/man/dropdown_extra.Rd @@ -15,6 +15,9 @@ dropdown_extra(id, choices, key = NULL, ...) \item{...}{parameters of date input, only \code{class} is supported for now} } +\value{ +Custom JS dropdown renderer for reactable +} \description{ Select input for reactable column cell } diff --git a/man/text_extra.Rd b/man/text_extra.Rd index 14206c7..4e7ef38 100644 --- a/man/text_extra.Rd +++ b/man/text_extra.Rd @@ -13,6 +13,9 @@ text_extra(id, key = NULL, ...) \item{...}{parameters of text input, only \code{class} is supported for now} } +\value{ +Custom JS text input renderer for reactable +} \description{ Text input for reactable column cell } diff --git a/man/tooltip_extra.Rd b/man/tooltip_extra.Rd index c41f512..0b0fc2e 100644 --- a/man/tooltip_extra.Rd +++ b/man/tooltip_extra.Rd @@ -12,6 +12,9 @@ tooltip_extra(content, theme = "light") \item{theme}{The theme of the tool-tip, either "light", "light-border", "material" or "translucent"} } +\value{ +Custom JS tool-tip renderer for reactable +} \description{ Tool-tip for table headers }