Get Started

In admiralmetabolic: Metabolism Extension Package for ADaM in 'R' Asset Library

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Introduction

As this is a package extension, if you are new to {admiral} then the best place to first start reading would be the Get Started page. This extension package follows the same main idea and conventions, and re-uses many functions from {admiral}, so it is important to thoroughly understand these to be able to use {admiralmetabolic}.

Derivations

The most important functions in {admiralmetabolic} are the derivations. Again these follow the same conventions as {admiral} but are focused to metabolism-specific needs.

Creating ADaM Datasets

For the metabolic ADaM data structures, an overview of the flow and example function calls for the most common steps are provided by the following vignettes:

• Creating a Control of Eating Questionnaire ADaM
• Creating a Metabolic ADVS ADaM

{admiralmetabolic} also provides template R scripts as a starting point. They can be created by calling use_ad_template() from {admiral}, e.g.,

library(admiral)

use_ad_template(
  adam_name = "advs",
  save_path = "./ad_advs.R",
  package = "admiralmetabolic"
)

A list of all available templates from {admiralmetabolic} can be obtained by list_all_templates() from {admiral}:

list_all_templates(package = "admiralmetabolic")

Support

Support is provided via pharmaverse Slack. Additionally, please feel free to raise issues in our GitHub repository.

admiralmetabolic documentation built on Aug. 8, 2025, 7:32 p.m.