Skip to content

Commit 1de507c

Browse files
committed
Update documentation
1 parent 7bf1248 commit 1de507c

4 files changed

Lines changed: 39 additions & 41 deletions

File tree

R/mod_edish.R

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -382,39 +382,44 @@ edish_server <- function(
382382
#' eDISH module
383383
#'
384384
#' `mod_edish()` displays the (modified) evaluation of Drug-Induced Serious Hepatotoxicity (eDISH/mDISH) plot
385-
#' to support the assessment of drug-induced liver injury (DILI).
385+
#' to support the assessment of drug-induced liver injury (DILI). The scatter plot depicts the correlation
386+
#' between peak values of an aminotransferase parameter and total bilirubin on a subject level.
386387
#'
387388
#' @param module_id `[character(1)]`
388389
#'
389390
#' A unique module ID.
390391
#'
391-
#' @param subject_level_dataset_name,lab_dataset_name `[character(1)]`
392+
#' @param subject_level_dataset_name `[character(1)]`
392393
#'
393-
#' Name(s) of the dataset(s) that will be displayed.
394+
#' Name of the subject-level dataset to be used.
395+
#'
396+
#' @param lab_dataset_name `[character(1)]`
397+
#'
398+
#' Name of the laboratory results dataset to be used.
394399
#'
395400
#' @param subjectid_var `[character(1)]`
396401
#'
397-
#' Name of the variable containing the unique subject IDs. Defaults to `"USUBJID"`.
402+
#' Name of the variable containing the unique subject IDs.
398403
#'
399404
#' @param arm_var `[character(1)]`
400405
#'
401-
#' Name of the variable containing the arm/treatment information. Defaults to `"ACTARM"`.
406+
#' Name of the variable containing the arm/treatment information.
402407
#'
403408
#' @param arm_default_vals `[character(1+) | NULL]`
404409
#'
405-
#' Vector specifying the default value(s) for the arm selector. Defaults to `NULL`.
410+
#' Vector specifying the default value(s) for the arm selector.
406411
#'
407412
#' @param visit_var `[character(1)]`
408413
#'
409-
#' Name of the variable containing the visit information. Defaults to `"VISIT"`.
414+
#' Name of the variable containing the visit information.
410415
#'
411416
#' @param baseline_visit_val `[character(1)]`
412417
#'
413-
#' Character indicating which visit should be used as baseline visit. Defaults to `"VISIT 01"`.
418+
#' Character indicating which visit should be used as baseline visit.
414419
#'
415420
#' @param lb_test_var `[character(1)]`
416421
#'
417-
#' Name of the variable containing the laboratory test information. Defaults to `"LBTEST"`.
422+
#' Name of the variable containing the laboratory test information.
418423
#'
419424
#' @param at_choices `[character(1+)]`
420425
#'
@@ -438,15 +443,11 @@ edish_server <- function(
438443
#'
439444
#' @param lb_result_var `[character(1)]`
440445
#'
441-
#' Name of the variable containing results of the laboratory test. Defaults to `"LBSTRESN"`.
442-
#' In case of multiple values in `lb_result_var` per `subjectid_var`, `visit_var`, and
443-
#' `lb_test_var`, only the maximum value will be used. Note that a NA value in the considered values
444-
#' will cause a value of NA to be returned as maximum value.
446+
#' Name of the variable containing results of the laboratory test.
445447
#'
446448
#' @param ref_range_upper_lim_var `[character(1)]`
447449
#'
448450
#' Name of the variable containing the reference range upper limits.
449-
#' Defaults to `"LBSTNRHI"`.
450451
#'
451452
#' @param default_by_visit `[logical(1)]`
452453
#'

man/edish_UI.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/edish_server.Rd

Lines changed: 7 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mod_edish.Rd

Lines changed: 16 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)