Merge pull request #44 from Appsilon/fix-cran-comments

chore: Resolve CRAN review comments.

Author: jakubnowicki

.Rbuildignore

@@ -6,3 +6,5 @@ vignettes
 pkgdown
 _\.new\.png$
 ^e2e_tests$
+^CRAN-SUBMISSION$
+^cran-comments\.md$

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

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, ...) {

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(

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) <doi:...>
+authors (year) <arXiv:...>
+authors (year, ISBN:...)
+or if those are not available: <https:...>
+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.

inst/WORDLIST

@@ -12,3 +12,4 @@ reactable
 customizable
 Codecov
 tooltips
+renderer