Document recent changes.

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dv.explorer.parameter
 Type: Package
 Title: Parameter exploration modules
-Version: 0.0.8
+Version: 0.0.9
 Authors@R: c(
         person("Boehringer-Ingelheim Pharma GmbH & Co.KG", role = c("cph", "fnd")),
         person(given = "Luis", family = "Moris Fernandez", role = c("aut", "cre"), email = "[email protected]"),

NEWS.md

@@ -1,3 +1,11 @@
+# dv.explorer.parameter 0.0.9
+
+* lineplot:
+    * Y axis log projection menu option.
+    * New `cdisc_visit_vars` parameter that accounts for missing Study Day 0 in CDISC datasets.
+    * New `default_transparency_value` parameter.
+    * Remove support for data dispatchers in favor of dataset names.
+
 # dv.explorer.parameter 0.0.8
 
 * WFPHM:

R/mod_lineplot.R

@@ -530,7 +530,16 @@ lp_median_summary_functions <- list(
 #'
 #' @param summary_functions `[list()]`
 #'
-#' TODO:
+#' Each element of this named list contains a summary function (e.g. a mean) and a collection of dispersion functions
+#' (e.g. standard deviation) defining ranges around the values returned by the summary function.
+#'
+#' The structure of each element is then a named list with the following elements:
+#' - `function`: Function that takes a numeric vector as its sole parameter and produces a scalar number.
+#' - `dispersion`: Named list of pairs functions that return the *top* and *bottom* dispersion ranges. They also take
+#'   a numeric vector as input and return a single numeric scalar
+#' - `y_prefix`: Prefix that will be prepended the Y axis label of the generated plot
+#'
+#' For an example, see `dv.explorer.parameter::lp_mean_summary_functions`.
 #'
 #' @param dataset_name `[shiny::reactive(*)]`
 #'
@@ -568,6 +577,14 @@ lp_median_summary_functions <- list(
 #'
 #' Default values for the selectors
 #'
+#' @param default_y_axis_projection `[character(1)|NULL]`
+#'
+#' Default values for the selectors
+#'
+#' @param default_transparency `[numeric(1)]`
+#'
+#' Default values for the selectors
+#'
 #' @export
 #'
 lineplot_server <- function(id,
@@ -1471,9 +1488,6 @@ lineplot_server <- function(id,
 #'
 #' Dataset names
 #'
-#' @param bm_dataset_disp,group_dataset_disp `[mm_dispatcher(1)]`
-#' module manager dispatchers that used as `bm_dataset` and `group_dataset` to `lineplot_server`
-#'
 #' @param receiver_id `[character(1)]`
 #'
 #' Name of the module receiving the selected subject ID in the single subject listing. The name must be present in
@@ -1521,7 +1535,7 @@ mod_lineplot <- function(module_id,
 
   # NOTE(miguel): These two lines allow the caller to provide lists whenever `mod_patient_profile_server`
   #               requires atomic arrays
-  args <- T_honor_as_array_flag(mod_patient_profile_API, args)
+  args <- T_honor_as_array_flag(mod_lineplot_API, args)
   list2env(args[setdiff(seq_along(args), 1)], environment()) # overwrite current arguments with modified `args`
 
   mod <- list(
@@ -1613,4 +1627,4 @@ mod_lineplot <- function(module_id,
     module_id = module_id
   )
   return(mod)
-}
+}