Learn R Programming

metalite

Unified representation of metadata structure for clinical analysis & reporting (A&R) by leveraging the Analysis Data Model (ADaM) datasets.

Installation

The easiest way to get metalite is to install from CRAN:

install.packages("metalite")

Alternatively, to use a new feature or get a bug fix, you can install the development version of metalite from GitHub:

# install.packages("remotes")
remotes::install_github("Merck/metalite")

Overview

The metalite framework is designed to:

  • Standardize function input for analysis and reporting.
  • Separate analysis logic from data source.
  • Enable the use of pipes (|>).
  • Reduce manual steps to develop and maintain documentation in clinical trial development.
  • Ensure consistency between analysis specification, mock, and results.

Use cases

The metalite package offers a foundation to simplify tool development and create standard engineering workflows. For example, metalite can be used to:

  • Standardize input and output for A&R functions.
  • Create analysis and reporting planning grid.
  • Create mock table.
  • Create and validate A&R results.
  • Trace analysis records.

Note: metalite is a low-level R package that needs to work with other R packages to complete the work. The idea is illustrated in the diagram above.

Design principles

We built metalite with the following principles:

  • Automation: prefer a function call more than a checklist.
  • Single-entry: enter in one place, sync to all deliveries.
    • For example, enter data source one time for all AE analysis.
  • End-to-end: cover all steps in software development lifecycle (SDLC) from define to delivery.

Copy Link

Version

Install

install.packages('metalite')

Monthly Downloads

270

Version

0.1.4

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Yujie Zhao

Last Published

August 22nd, 2024

Functions in metalite (0.1.4)

meta_run

Execute analysis based on the analysis plan
define_parameter

Define analysis parameter meta information for ADaM dataset
meta_split

Split metadata into groups
outdata

Construct outdata class
plan

Create a analysis plan from all combination of variables
get_label

A function to get the labels of data frame columns
meta_add_total

Add duplicate data to enable a total group
meta_adam

Create a metadata representation for ADaM data analysis
collect_title

Collect specification for title
default_apply

Apply default values to ADaM mappings
spec_call_program

Specification for analysis call program
meta_example

Create an example meta_adam object
meta_build

Build complete meta information
spec_filename

Specification for analysis output filename
define_plan

Define analysis plan meta information for ADaM dataset
meta_inherit

Inherit meta information by keywords
meta_example_exploration

Create a data exploration meta_adam object
spec_title

Specification for analysis title
update_adam_mapping

Update mapping rule in adam_mapping
assign_label

A function to assign labels to a data frame
collect_dataname

Collect specification for dataset name
add_plan

Add additional analysis plan
adam_mapping

Construct ADaM mappings
collect_population_id

Collect subject identifier information from population dataset
collect_observation_index

Collect observation record index from observation dataset
collect_observation_record

Collect observation record from observation dataset
collect_population

Collect specification for population definition
collect_adam_mapping

Collect adam_mapping from meta_adam by name
collect_n_subject

Collect number of subjects and its subset condition
define_population

Define analysis population meta information for ADaM dataset
define_analysis

Define analysis function meta information for ADaM dataset
print.meta_adam

Print a metadata object with its population, observation, and analysis plans
define_observation

Define analysis observation meta information for ADaM dataset
collect_population_index

Collect population record index from population dataset
spec_analysis_population

Specification for population definition
collect_population_record

Collect population record from population dataset
n_subject

Count number of unique subjects
metalite-package

metalite: ADaM Metadata Structure