update documentation

Boehringer-Ingelheim · Dec 11, 2024 · 88b7696 · 88b7696
1 parent d3a8511
commit 88b7696
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 28 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -45,7 +45,6 @@ Suggests:
     testthat (>= 3.2.1)
 Config/testthat/edition: 3
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Remotes: boehringer-ingelheim/[email protected]
 VignetteBuilder: knitr
-
diff --git a/NAMESPACE b/NAMESPACE
@@ -4,6 +4,7 @@ export("%>%")
 export(default_basic_info)
 export(default_drug_admin)
 export(default_mapping)
+export(mock_clinical_timelines_app)
 export(mock_with_mm_app)
 export(mod_clinical_timelines)
 export(mod_clinical_timelines_UI)

diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,7 @@
 * Allow for customized color palettes.
 * Use dv.manager's switch2mod() instead of deprecated switch2() function.
 * Export mock app.
+* Fix error occurring in case only timepoints (i.e., no intervals) are specified.
 
 # dv.clinlines 1.0.4
 

diff --git a/R/mock_clinical_timelines.R b/R/mock_clinical_timelines.R
@@ -10,7 +10,7 @@ mock_clinical_timelines_UI <- function(id = NULL) { # nolint
 
   ui <- shiny::fluidPage(
     theme = bslib::bs_theme(version = "4"),
-    shiny::tags$h1("BI Clinical Timelines", class = "mod-title"),
+    shiny::tags$h1("DaVinci's Clinical Timelines Module", class = "mod-title"),
     mod_clinical_timelines_UI(
       ns("clin_tl"),
       list("serious_ae_var", "soc_var", "pref_term_var", "drug_rel_ae_var")

diff --git a/man/check_valid_color.Rd b/man/check_valid_color.Rd
diff --git a/man/color_lookup.Rd b/man/color_lookup.Rd
diff --git a/man/figures/clin-tl_main_view.PNG b/man/figures/clin-tl_main_view.PNG
diff --git a/man/mock_with_mm_app.Rd b/man/mock_with_mm_app.Rd
diff --git a/man/mod_clinical_timelines.Rd b/man/mod_clinical_timelines.Rd
diff --git a/man/mod_clinical_timelines_server.Rd b/man/mod_clinical_timelines_server.Rd
diff --git a/man/prep_data.Rd b/man/prep_data.Rd
diff --git a/man/set_drug_admin.Rd b/man/set_drug_admin.Rd
diff --git a/vignettes/clinlines.Rmd b/vignettes/clinlines.Rmd
@@ -141,7 +141,12 @@ Optional parameters of `mod_clinical_timelines()` are:
 
 -   `filter`: Defaults to `NULL`, which means no local filters for adverse event data will be offered within the module. Filters can be activated by providing their names through a list (see `vignette("ae-filter")`).
 
-- `receiver_id`: Character string defining the ID of the module to which to send a subject ID. The corresponding module must exist in the module list. The default is NULL which disables communication. See `vignette("communication")` for further information. 
+- `receiver_id`: Optional character string defining the ID of the module to which to send a subject ID. The corresponding module must exist in the module list. The default is NULL which disables communication. See `vignette("communication")` for further information. 
+
+- `default_plot_settings`: An optional named list containing three elements: `x_param` defines if the x axis shows the date or study days as default setting at app launch, `start_day` indicates the lower x-axis limit in case of study day display at app launch, and `boxheight_val` defines the initial height of the individual timeline plot boxes at app launch.
+
+- `color_palette`: An optional named vector that allows customizing the colors for drawing events or intervals.
+
 
 An illustrative definition of a module list (containing only a Clinical Timelines module with only mandatory parameters) is shown below: