tableClinData: Create a 'clinical data table', associated to a plot.

View source: R/plots-tableClinData.R

tableClinDataR Documentation

Create a 'clinical data table', associated to a plot.

Description

Interactive table is created, with the possibility to have clickeable link to patient-specific report, and included within a button.

Usage

tableClinData(
  data,
  idVar = "USUBJID",
  idLab = getLabelVar(idVar, labelVars = labelVars),
  keyVar = NULL,
  keyLab = getLabelVar(keyVar, labelVars = labelVars),
  pathVar = NULL,
  pathLab = getLabelVar(pathVar, labelVars = labelVars),
  pathExpand = FALSE,
  tableVars = colnames(data),
  tableLab = getLabelVar(tableVars, labelVars = labelVars),
  tableButton = TRUE,
  tablePars = list(),
  id = paste0("plotClinData", sample.int(n = 1000, size = 1)),
  labelVars = NULL,
  verbose = FALSE
)

Arguments

data

Data.frame with data.

idVar

String with variable containing subject ID.

idLab

String with label for idVar.

keyVar

String with unique key variable, identifying unique group for which the link between the table and the plot should be done.

keyLab

String with label for keyVar.

pathVar

String with variable of data containing hyperlinks with path to the subject-specific report, formatted as:

<a href="./path-to-report">label</a>

.
If multiple, they should be separated by: ', '.
The report(s) will be:

  • compressed to a zip file and downloaded if the user clicks on the 'p' (a.k.a 'profile') key when hovering on a point of the plot

  • included in a collapsible row, and clickable with hyperlinks in the table

pathLab

String with label for pathVar, included in the collapsible row in the table.

pathExpand

Logical, should the variable in pathExpand be included in a collapsible row or as hyperlink in the table? Should be TRUE for if multiple paths are included for each idVar, FALSE otherwise (by default).

tableVars

Character vector with variables to be included in the table.

tableLab

Named character vector with labels for each tableVars.

tableButton

Logical, if TRUE (by default) the table is included within an HTML button.

tablePars

List with parameters passed to the getClinDT function.

id

String with general id for the plot:

  • 'id' is used as group for the SharedData

  • 'button:[id]' is used as button ID if table is TRUE

If not specified, a random id, as 'plotClinData[X]' is used.

labelVars

Named character vector containing variable labels.

verbose

Logical, if TRUE (FALSE by default) progress messages are printed in the current console.

Value

datatable

Author(s)

Laure Cougnaud


clinDataReview documentation built on March 7, 2023, 5:13 p.m.