Merge pull request #103 from Appsilon/fix-check

Prepare package for CRAN submission

Author: kamilzyla

DESCRIPTION

@@ -1,50 +1,61 @@
 Package: shiny.telemetry
 Type: Package
-Title: Shiny app usability logs and statistics
-Version: 0.0.9009
-Author: Appsilon Data Science <dev@appsilondatascience.com>
-Maintainer: Appsilon Data Science <dev@appsilondatascience.com>
-Description: Easy way for logging users activity and adding statistics panel to your Shiny app.
+Title: Shiny App Usage Telemetry
+Version: 0.1.0
+Authors@R:
+  c(
+    person("Kamil", "Żyła", role = c("aut", "cre"), email = "opensource+kamil@appsilon.com"),
+    person("André", "Veríssimo", role = "aut", email = "andre.verissimo@appsilon.com"),
+    person("Krystian", "Igras",  role = "aut", email = "krystian8207@gmail.com"),
+    person("Recle", "Vibal", role = "aut", email = "recle.vibal@appsilon.com"),
+    person("Appsilon Sp. z o.o.", role = "cph", email = "opensource@appsilon.com")
+  )
+Description:
+  Enables instrumentation of 'Shiny' apps for tracking user session events
+  such as input changes, browser type, and session duration.
+  These events can be sent to any of the available storage backends
+  and analyzed using the included 'Shiny' app to gain insights about app usage and adoption.
 License: LGPL-3
 Encoding: UTF-8
 LazyData: true
 Suggests:
-    plumber,
-    box,
-    stringr,
-    here,
-    testthat (>= 3.0.0),
-    mockery,
-    withr,
-    lintr,
-    spelling,
-    rcmdcheck,
-    RPostgreSQL,
-    RMariaDB,
-    timevis,
-    RColorBrewer,
-    plotly,
-    DT,
-    shinyjs,
-    scales,
-    semantic.dashboard (>= 0.1.1),
-    shiny.semantic (>= 0.2.0),
-    config
-Imports: purrr,
-    tidyr,
-    dplyr,
-    odbc,
-    jsonlite,
-    logger,
-    R6,
-    RSQLite,
-    rlang,
-    checkmate,
-    glue,
-    shiny,
-    httr2,
-    digest,
-    lubridate
+  box,
+  config,
+  DT,
+  here,
+  lintr,
+  mockery,
+  plotly,
+  plumber,
+  rcmdcheck,
+  RColorBrewer,
+  RMariaDB,
+  RPostgreSQL,
+  scales,
+  semantic.dashboard (>= 0.1.1),
+  shiny.semantic (>= 0.2.0),
+  shinyjs,
+  spelling,
+  stringr,
+  testthat (>= 3.1.7),
+  timevis,
+  withr
+Imports:
+  checkmate,
+  digest,
+  dplyr (>= 1.1.0),
+  glue,
+  httr2,
+  jsonlite,
+  logger,
+  lubridate,
+  odbc,
+  purrr,
+  R6,
+  rlang,
+  RSQLite,
+  shiny,
+  tidyr
 RoxygenNote: 7.2.3
 Config/testthat/edition: 3
 Language: en-US

R/data-storage-log-file.R

@@ -7,6 +7,7 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' data_storage <- DataStorageLogFile$new(
 #'   log_file_path = tempfile(pattern = "user_stats", fileext = ".txt")
 #' )
@@ -22,6 +23,7 @@
 #'
 #' data_storage$read_event_data()
 #' data_storage$read_event_data(Sys.Date() - 1, Sys.Date() + 1)
+#' }
 DataStorageLogFile <- R6::R6Class( # nolint object_name_linter
   classname = "DataStorageLogFile",
   inherit = DataStorage,

R/data-storage-sqlite.R

@@ -7,6 +7,7 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' data_storage <- DataStorageSQLite$new(
 #'   db_path = tempfile(pattern = "user_stats", fileext = ".sqlite")
 #' )
@@ -22,6 +23,7 @@
 #'
 #' data_storage$read_event_data()
 #' data_storage$read_event_data(Sys.Date() - 1, Sys.Date() + 1)
+#' }
 DataStorageSQLite <- R6::R6Class( # nolint object_name_linter
   classname = "DataStorageSQLite",
   inherit = DataStorageSQLFamily,

R/telemetry.R

@@ -19,6 +19,7 @@
 #' @seealso [shiny.telemetry::DataStorage] which this function wraps.
 #' @export
 #' @examples
+#' \dontrun{
 #' telemetry <- Telemetry$new(
 #'   data_storage = DataStorageLogFile$new(
 #'     log_file_path = tempfile(pattern = "user_stats", fileext = ".txt")
@@ -55,6 +56,7 @@
 #' telemetry$log_custom_event("a_button", list(custom_field = 23), session = session)
 #'
 #' telemetry$data_storage$read_event_data("2020-01-01", "2025-01-01")
+#' }
 Telemetry <- R6::R6Class( # nolint object_name_linter
   classname = "Telemetry",
   public = list(

man/DataStorageLogFile.Rd

@@ -14,6 +14,8 @@ logger::log_threshold(logger::FATAL, namespace = "shiny.telemetry")
 Sys.setenv(R_CONFIG_ACTIVE = "test")
 
 test_that("[Plumber] DataStorage should be able to insert and read", {
+  skip_on_cran()
+
   db_path <- tempfile(pattern = "events", fileext = ".sqlite")
 
   old_env <- capture_evironment_variables(
@@ -78,6 +80,8 @@ test_that("[Plumber] DataStorage should be able to insert and read", {
 })
 
 test_that("Plumber API works", {
+  skip_on_cran()
+
   db_path <- tempfile(pattern = "events", fileext = ".sqlite")
 
   old_env <- capture_evironment_variables(
@@ -138,6 +142,8 @@ test_that("Plumber API works", {
 
 
 test_that("Plumber API token only accepts valid messages", {
+  skip_on_cran()
+
   db_path <- tempfile(pattern = "events", fileext = ".sqlite")
 
   old_env <- capture_evironment_variables(

man/DataStorageSQLite.Rd

@@ -1,6 +1,8 @@
 # Test that performs integration checks on how Telemetry class works with a
 #  valid data storage provider.
 test_that("[Plumber] Telemetry writes and reads events (integration)", {
+  skip_on_cran()
+
   db_path <- tempfile(pattern = "events", fileext = ".sqlite")
 
   old_env <- capture_evironment_variables(