Assess All Usability Indicators — usability

Convenience wrapper that runs all four usability assessments and returns a combined evidence table. This is the primary entry point for the r4subusability package.

Usage

usability_indicators(metadata, assets = character(0), ctx, config = NULL)

Arguments

metadata: A data frame with columns dataset, variable, label, origin, derivation (optional), and codelist (optional). Compatible with the adam_metadata and sdtm_metadata datasets from r4subdata.
assets: A character vector of asset names present in the submission package. Used by assess_reviewer_guide(). Defaults to character(0).
ctx: A run context created by r4subcore::r4sub_run_context().
config: A configuration list from usability_config_default(). If NULL the default configuration is used.

Value

A validated evidence tibble combining results from all four usability assessments (see r4subcore::as_evidence()).

Examples

ctx <- suppressMessages(r4subcore::r4sub_run_context(study_id = "STUDY01"))
ev  <- suppressMessages(usability_indicators(
  r4subdata::oncology_metadata,
  assets = c("ADRG", "define.xml"),
  ctx = ctx
))
table(ev$indicator_id, ev$result)
#>        
#>         fail pass
#>   U-001    0   32
#>   U-002    3   29
#>   U-003    1    2
#>   U-004    0    1