continue

.gitignore

@@ -42,3 +42,4 @@ vignettes/*.pdf
 .DS_Store
 docs
 shiny/
+inst/doc

DESCRIPTION

@@ -42,11 +42,14 @@ Suggests:
     ggplot2,
     here,
     htmlwidgets,
+    knitr,
     plotly,
+    rmarkdown,
     shinycssloaders,
     shinyWidgets,
     testthat (>= 3.1.5),
     utils,
     zip
 Remotes:
     darwin-eu-dev/omopgenerics
+VignetteBuilder: knitr

R/visOmops.R

@@ -53,7 +53,16 @@ visTable <- function(result,
   return(result)
 }
 
-# # facet
+# warning if default plot tab
+
+# plotCohortTiming() ----
+#
+# plotCohortCharacteristics() ----
+# facet = <groupping, settings, variable>
+# x = <groupping, settings, variable>
+# plotType = boxplot/barplot
+# colour = <groupping, settings, variable> -> NULL
+# # facet ----
 # # colour
 # visPlot <- function(result,
 #                     facet = NULL,

data-raw/internalData.R

@@ -1,8 +1,30 @@
 ## code to prepare `DATASET` dataset goes here
 
 resultTypeTabs <- dplyr::tribble(
-  ~result_type, ~title, ~icon, ~raw, ~formatted, ~plot,
-  "summarised_characteristics", "Cohort characteristics", "people-group", TRUE, TRUE, TRUE
+  ~result_type, ~title, ~icon,
+  "summarised_characteristics", "Cohort characteristics", "people-group"
+)
+
+plotType = boxplot/density
+# timeScale = days/years
+# facet = <groupping/settings/variable>
+# colour = <groupping/settungs/variable>
+# uniqueCombinations = #check#
+
+resultTypePlots <- list(
+  "functions" = dplyr::tribble(
+    ~plot_id, ~result_type, ~package, ~fun, ~output,
+    1L, "cohort_overlap", "CohortCharacteristics", "plotCohortOverlap", "ggplot2",
+    2L, "cohort_attrition", "CohortCharacteristics", "plotCohortAttrition", "grViz",
+    3L, "cohort_timing", "CohortCharacteristics", "plotCohortTimming", "ggplot2"
+  ),
+  "arguments" = dplyr::tribble(
+    ~plot_id, ~argument, ~type, ~opts,
+    1L, "facet", "selector", "<groupping>, <variable>, <settings>",
+    1L, "uniqueCombinations", "check", "",
+    3L, "plotType", "selector", "boxplot, density",
+    3L, "timeScale", "selector", "days, years"
+  )
 )
 
 proj <- c(
@@ -147,4 +169,6 @@ plot_config <- list(
 )
 # end plot config ----
 
-usethis::use_data(resultTypeTabs, proj, global, plot_config, overwrite = TRUE, internal = TRUE)
+usethis::use_data(
+  resultTypeTabs, resultTypePlots, proj, global, plot_config, overwrite = TRUE,
+  internal = TRUE)

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R

vignettes/supported_result_type.Rmd

@@ -0,0 +1,34 @@
+---
+title: "Plot tabs in omopViewer"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{supported_result_type}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r, echo=FALSE}
+x <- omopViewer:::resultTypePlots$functions
+```
+
+
+The **omopViewer** package supports `r x$result_type |> unique() |> length()` result types of `r x$package |> unique() |> length()` packages: `r cli::cli_text("{.pkg {unique(x$package)}}") |> cli::cli_fmt()`.
+
+You can see the plot functions that have been configured in the package per result type in the following table:
+
+```{r, echo = FALSE}
+x |>
+  dplyr::select(
+    "Result type" = "result_type", "package", "Plot function" = "fun") |>
+  visOmopResults::gtTable(
+    groupColumn = "package", colsToMergeRows = "Result type")
+  
+```
+