Skip to content

admiral

1.5.0Package record

ADaM in R Asset Library

7packages dependsuggested by 4
45.5Kdownloads / year
99.7%test coverage
13/13flavors OK

Overview

About
Maintained by Edoardo ManciniCRAN page ↗GitHub ↗Website ↗Issues ↗Declared funders: F. Hoffmann-La Roche AG and GlaxoSmithKline LLC

A toolbox for programming Clinical Data Interchange Standards Consortium (CDISC) compliant Analysis Data Model (ADaM) datasets in R. ADaM datasets are a mandatory part of any New Drug or Biologics License Application submitted to the United States Food and Drug Administration (FDA). Analysis derivations are implemented in accordance with the "Analysis Data Model Implementation Guide" (CDISC Analysis Data Model Team, 2021, https://www.cdisc.org/standards/foundational/adam).

Changes in 1.5.0

Updates of Existing Functions

  • derive_vars_dt() and derive_vars_dtm() were enhanced to allow user-defined date_imputation values (e.g.

date_imputation = "10") in combination with highest_imputation = "D". Additionally,

functions such as derive_vars_dt(), derive_vars_dtm(), impute_dtc_dt() and

impute_dtc_dtm() now issue an error if any invalid dates (e.g. "2020-02-31"). (#3014)

  • The end_dates argument for specifying dates which restrict the observation

period and the event_type argument for specifying if the event is negative

(progression, death, worsening, ...) were added to derive_param_tte(). The

consider_end_dates field was added to the event_source(), censor_source(),

and tte_source() objects. (#2952)

  • The by_vars and the tmp_obs_nr_var arguments were added to event_joined(). This allows to derive parameters requiring confirmation _by visit_ using derive_extreme_event(). (#3022)
Show all changes in 1.5.0Hide the rest of the changes in 1.5.0
  • The filter_source argument was added to event_joined(), allowing to

specify a condition to restrict the source dataset before the join, e.g., when

using derive_extreme_event(). (#3033)

  • The filter_add argument in derive_var_joined_exist_flag() is no longer

erroneously ignored. (#3018)

  • Poorly formatted warning messages in derive_param_computed() and derive_vars_computed() were improved. (#2969)
  • Fixed typo in derive_summary_records() error message. (#3127)
  • use_ad_template() was updated to remove the open argument, meaning the generated template will never automatically open

in a new window, and will instead just be accessible by clicking the link outputted in the console or going to the path

specified under save_path. This is because this functionality did not work as expected outside of RStudio. (#2989)

  • The NCICTCAEv5 grading criteria (atoxgr_criteria_ctcv5, atoxgr_criteria_ctcv5_uscv) were updated

to add the term "Blood lactate dehydrogenase increase" (#3025).

  • The missing_values argument was added to derive_extreme_records(). This allows users to specify values for variables in the new records originating from dataset_ref. (#3017)
  • list_all_templates() now only lists out .R files with the templates folder

of the target package. (#3136)

Breaking Changes

  • The following function arguments are entering the next phase of the deprecation process: **Phase 1 (message)** No functions or arguments in this phase. **Phase 2 (warning)** No functions or arguments in this phase. **Phase 3 (error)**
  • call_user_fun() is deprecated and will have no replacement.

**Phase 4 (removed)**

No functions or arguments in this phase.

  • The ex_single dataset was removed from {admiral} to reduce the package size. It can be derived on the fly using create_single_dose_dataset(). See the OCCDS vignette or ?create_single_dose_dataset for examples. (#3060)

Documentation

  • A new article "Time-to-Event Analyses" was added to provide guidance for different TTE scenarios. (#2900)
  • The following new and existing User Guides have been changed from vignettes to articles, meaning they are no longer accessible

offline via vignette("vignette_name"):

  • Creating an ADAB ADaM
  • Estimands (new) This helps minimize the size of {admiral} for installation. The articles are still accessible through the User Guides section of the

admiral website. (#3067)

  • The documentation for derive_var_merged_ef_msrc() was enhanced with structured examples covering flag_events with multiple

sources, customizing true_value, false_value, and missing_value, and per-source by_vars renaming. (#2906)

  • The UDTC derivation in ADPPK was updated to use source domain DTC variables. (#3011)
  • The example for derive_var_nfrlt() was updated to use NA_character_ instead of "" for missing unit values, consistent with

the {admiral} programming strategy. (#3027)

  • A new web-only "Estimands" article was added, describing possible implementations of Estimands with {admiral} code. (#2954)
  • A night mode option has been added to the {admiral} website. This can be be toggled using the sun/moon icon in the top right corner

of the navigation bar. Tooltips have also been set up for each of the icons on the navigation bar. (#2959)

of packages were updated to specify the level of contributions required for authorship/acknowledgments. (#2979)

  • The examples for derive_basetype_records() were enhanced to include a case where records that do not match any condition in basetypes are retained with BASETYPE set to NA. (#2904)
  • Additional information about timing variable conventions has been added to the derive_vars_dy() function documentation. (#2995)
  • The documentation for derive_vars_merged_summary() was enhanced with structured examples covering

the new_vars, filter_add, missing_values, by_vars renaming, and string aggregation use cases. (#2775)

  • A new custom 404 page was added with a butterfly quiz for lost users. (#2982)
  • Added information about how to print out records with missing information when using datasetref in derive_summary_records(). (#3012)
  • Usage of ASEQ (an optional variable) was clarified within the corresponding Vignettes and Templates. (#2986)
  • The derivation of DOSEON and DOSEU variables in the OCCDS vignette was clarified and generalized to cover more scenarios. (#3101)
  • The documentation for derive_vars_dtm() and derive_vars_dt() was updated to clarify details of the highest_imputation argument. (#3055)
  • The "Date and Time Imputation" vignette was updated to point out the difference between the character *DTC variables and the numeric *DTM variables. (#3055)
  • The documentation for compute_*() and other computation functions was updated to clarify

that they are vector-oriented helpers and are not usually called directly on a

data frame with %>%. (#3146)

  • Added notes and examples for deriving baseline toxicity grade variables (BTOXGR, BTOXGRL, BTOXGRH) in the Lab Grading vignette. (#3119)

Various

<details>

<summary>Developer Notes</summary>

  • Update to roxygen2 8.0.0. (#3090)
  • The admiral_labels_attrs_section() function was added to output standardized boilerplate markdown for the "Add Labels and Attributes" section in ADaM-specific vignettes. All relevant vignettes have been updated to use this function, ensuring consistent content that can be maintained in one place. (#2926)
  • Add instructions for AI coding agents: Workflow from {admiralci} copies information from {admiraldev} to AGENTS.md instruction files. (#2920)
  • Increased the maximum height of the drop-down menus in the website navigation bar to ensure all items are visible without scrolling. (#2974)
  • Creating the website for pull requests was enabled. Add "[create website]" to

the pull request title to trigger website creation. (#2984)

  • _pkgdown.yml was updated to add metadata for linking across packages

(inst/pkgdown.yml). (#2950)

  • The helper functions roxygen_param_dataset(), roxygen_param_by_vars(), roxygen_order_na_handling(), and roxygen_save_memory() have been moved from {admiral} to {admiraldev}. They are now exported from {admiraldev} and remain accessible in {admiral} via the existing @import admiraldev dependency. (admiraldev/#517)
  • The HTML tag <br/> was removed from the roxygen headers. (#3042)
  • Clickable links to personal websites or GitHub profiles were added in the home page sidebar for every {admiral} author. (#3112)

</details>

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 14.0 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-09-08
  • ERROR12 OK, 1 ERROR2026-09-07
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK13 OK2026-06-09
Show 2 earlier changesHide 2 earlier changes
  • ERROR12 OK, 1 ERROR2026-06-08
  • OK14 OK2026-03-10
Advisories

none known

Documentation

In release 1.5.0
READMEYes · 1,802 wordsVignettesYes · 18 · dynamicNEWSYes · 100% structured · mentions 1.5.0Citation fileNoWebsiteYes · pkgdown

The repository also keeps web-only articles.

Help pages
188 (38 internal)includes a package overview page
Examples that run
100%126 run in a plain check (1 of them under a condition)
Exported functions with examples
76%
Documented parameters
99%
Return-value docs
94%
Help pages citing references
0%

Downloads

45.5K
CRAN downloads in the past year
Rank #2,015 · ~125/day · ~3.8K/mo
Daily download trend is not available in this view yet.
3.6K30 days
9.1K90 days
45.5K1 year
Compare downloads with other packages →
Also on468 r2u31 autocran1.6K conda_forge

Repository

323Stars
111Forks
15Open issues
5Open PRs
38Releases
4,963Commits
122Commit identities
cdiscclinical-trialsopen-sourceradampharmaverse
License file reads as Apache-2.0 · 4,963 commits · Last activity 2026-10-12 · +1.6% stars, 30d · Default branch at 1.5.0.9017, ahead of CRAN 1.5.0 (checked 2026-10-11) · Discussions: 73 posts
Responsiveness
How these are sampled
PRs merged (all time)
78%
Median days to close, 50 most recently updated closed issues
12
Median days to close, 50 most recently updated closed PRs
3

Stars over time

2025-10-08 · 2482026-10-12 · 323
PracticesBeta

9 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/pharmaverse/admiral on 2026-10-11.

Continuous integration (1)
GitHub Actions
Governance and community (4)
Code of conductContributing guideIssue templatesPR template
Docs source (2)
pkgdown

GitHub Pages site last deployed 2026-10-09

Reproducibility and dev environment (1)
data-raw/
Show all practicesHide 1 practice
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v3 (2026-09-26)
AI coding toolsBeta

This repository shows signs of AI coding tools.

  • GitHub Copilotfirst seen 2025-11-20
    Pull request: opened by its own account
    Commits: 39 by its own account · at least 43 crediting it in the message
  • Claude Codefirst seen 2026-07-14
    Named in .gitignore: CLAUDE.md
    Pull request it wrote: opened by a project member
    Commits: at least 4 crediting it in the message
Shared conventions any agent may read, so they name no particular tool.
Seen in the repository: AGENTS.md
From outside contributors
  • Claude Code
    Pull requests: 1 from outside contributors, first on 2026-09-21
Models named in its commits
  • Claude Sonnet 53 commits · Aug to Sep 2026
  • Claude Opus 4.81 commit · Jul 2026
Counts are commits, not lines of code. Commits by a tool's accounts count once across all of its accounts. Commits crediting it are the largest count among its credit lines, a minimum.How this is detected·Detection ruleset v4 (updated 2026-09-27)

Dependencies

Declared dependencies
26 external dependencies (excludes base and recommended)

Installing admiral adds 43 packages (23 with compiled code, 23 MB of source tarballs). Heaviest: stringi 11 MB, fs 1.4 MB, admiraldev 1.0 MB.

Depends (1)
R >= 4.1
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
7direct
0indirect
Imports 7
Suggested by 4
Depends, Imports or LinkingTo, most downloaded first
Suggests, most downloaded first

Datasets

People & History

People (13)
Author, Maintainer since 1.4.2 (2026) · added in 0.11.0
Author · added in 1.3.0
Author · added in 1.4.0
Author · added in 0.9.0
Author · added in 1.1.0
Author · added in 1.5.0
Author · added in 1.1.0
Copyright holder, Funder
Copyright holder, Funder

Previously maintained by Ben Straub (0.10.2 to 1.4.1) and Thomas Neitmann (0.6.3 to 0.10.1).

Listed in earlier versions (59)
Show 8 of 59 peopleHide 8 people
Teckla Akinyi
no longer listed · 0.6.3 to 0.11.1
Alice Ehmann
no longer listed · 0.6.3 to 0.11.1
no longer listed · 0.6.3 to 0.11.1
no longer listed · 0.6.3 to 0.11.1
Robin Koeger
no longer listed · 0.6.3 to 0.11.1
Konstantina Koukourikou
no longer listed · 0.6.3 to 0.11.1
Pavan Kumar
no longer listed · 0.6.3 to 0.11.1
no longer listed · 0.6.3 to 1.0.2
Releases (31)

Pick two releases to compare their code metrics.

  • 1.5.0Latest
    record
    2026-06-12 · current release · diff ↗ ·
    added 1 export
    admiral_labels_attrs_section
  • 1.4.2
    record
    2026-05-28 · diff ↗
  • R
    R 4.6.0 released · 2026-04-24
  • 1.4.1
    record
    2026-02-03 · diff ↗
  • 1.4.0
    record
    2026-01-15 · diff ↗ ·
    added 3 exports
    convert_xxtpt_to_hours, derive_var_nfrlt, derive_vars_merged_summary
  • 1.3.1
    record
    2025-07-29 · diff ↗
  • 1.3.0
    record
    2025-06-26 · diff ↗ ·
    added 1 export
    derive_vars_joined_summary
  • R
    R 4.5.0 released · 2025-04-11
  • 1.2.0
    record
    2025-01-15 · diff ↗ ·
    removed 2 exports
    country_code_lookup, dose_freq_lookup
    added 3 exports
    derive_vars_cat, derive_vars_crit_flag, transform_range
  • 1.1.1
    record
    2024-06-17 · diff ↗
  • 1.1.0
    record
    2024-06-07 · diff ↗ ·
    added 3 exports
    country_code_lookup, get_flagged_records, get_vars_query
  • R
    R 4.4.0 released · 2024-04-24
  • 1.0.2
    record
    2024-03-05 · diff ↗
  • 1.0.1
    record
    2024-02-02 · diff ↗
  • 1.0.0
    record
    2023-12-16 · diff ↗ ·
    removed 15 exports
    assert_terms, assert_valid_queries, derive_param_extreme_event, derive_var_basetype, derive_var_confirmation_flag, derive_var_last_dose_amt, derive_var_last_dose_date, derive_var_last_dose_grp, derive_var_merged_cat, derive_var_merged_character, derive_vars_last_dose, extend_source_datasets, filter_date_sources, validate_basket_select, validate_query
    added 4 exports
    derive_var_merged_ef_msrc, derive_vars_computed, derive_vars_extreme_event, flag_event
  • 0.12.3
    record
    2023-10-18 · diff ↗
Show 21 earlier eventsHide 21 earlier events
  • 0.12.2
    record
    2023-10-06 · diff ↗
  • 0.12.1
    record
    2023-09-25 · diff ↗
  • 0.12.0
    record
    2023-09-12 · diff ↗ ·
    removed 5 exports
    derive_var_disposition_status, derive_var_worst_flag, derive_vars_disposition_reason, format_eoxxstt_default, format_reason_default
    added 1 export
    event_joined
  • 0.11.1
    record
    2023-07-06 · diff ↗
  • 0.11.0
    record
    2023-06-09 · diff ↗ ·
    removed 8 exports
    derive_derived_param, derive_param_first_event, derive_var_agegr_ema, derive_var_agegr_fda, derive_vars_merged_dt, derive_vars_merged_dtm, filter_confirmation, vars
    added 7 exports
    compute_age_years, compute_egfr, derive_basetype_records, derive_param_extreme_record, filter_exist, filter_not_exist, records_source
  • 0.10.2
    record
    2023-04-25 · diff ↗
  • R
    R 4.3.0 released · 2023-04-21
  • 0.10.1
    record
    2023-03-14 · diff ↗
  • 0.10.0
    record
    2023-03-08 · diff ↗ ·
    removed 7 exports
    derive_var_ady, derive_var_aendy, derive_var_astdy, derive_var_atirel, derive_vars_suppqual, sdg_select, smq_select
    added 8 exports
    compute_scale, consolidate_metadata, derive_expected_records, derive_extreme_event, derive_var_joined_exist_flag, event, exprs, filter_joined
  • 0.9.1
    record
    2022-12-23 · diff ↗
  • 0.9.0
    record
    2022-12-06 · diff ↗ ·
    removed 4 exports
    filter_if, validate_sdg_select, validate_smq_select, vars2chr
    added 16 exports
    %>%, basket_select, chr2vars, convert_na_to_blanks, create_period_dataset, derive_locf_records, derive_param_extreme_event, derive_var_merged_summary, derive_var_relative_flag, derive_var_trtemfl, derive_vars_joined, derive_vars_period, get_admiral_option, print_named_list, set_admiral_options, validate_basket_select
  • 0.8.4
    record
    2022-10-14 · diff ↗
  • 0.8.3
    record
    2022-10-07 · diff ↗
  • 0.8.2
    record
    2022-09-29 · diff ↗
  • 0.8.1
    record
    2022-09-21 · diff ↗
  • 0.8.0
    record
    2022-09-05 · diff ↗ ·
    removed 32 exports
    assert_character_scalar, assert_character_vector, assert_data_frame, assert_filter_cond, assert_function, assert_has_variables, assert_integer_scalar, assert_list_element, assert_list_of, assert_logical_scalar, assert_numeric_vector, assert_one_to_one, assert_order_vars, assert_param_does_not_exist, assert_s3_class, assert_symbol, assert_unit, assert_vars, assert_varval_list, dataset_vignette, derive_last_dose, derive_var_disposition_dt, derive_var_lstalvdt, derive_var_trtedtm, derive_var_trtsdtm, expect_dfs_equal, impute_dtc, lstalvdt_source, suppress_warning, warn_if_inconsistent_list and 2 more
    added 18 exports
    compute_framingham, compute_qual_imputation, compute_qual_imputation_dec, count_vals, derive_param_computed, derive_param_framingham, derive_var_atoxgr, derive_var_atoxgr_dir, derive_var_confirmation_flag, derive_vars_merged_lookup, filter_confirmation, get_not_mapped, get_summary_records, impute_dtc_dt, impute_dtc_dtm, list_tte_source_objects, max_cond, min_cond
  • 0.7.1
    record
    2022-07-18 · diff ↗
  • 0.7.0
    record
    2022-05-31 · diff ↗ ·
    removed 12 exports
    derive_agegr_ema, derive_agegr_fda, derive_baseline, derive_disposition_dt, derive_disposition_reason, derive_disposition_status, derive_extreme_flag, derive_obs_number, derive_params_exposure, derive_var_basec, derive_worst_flag, exprs
    added 32 exports
    assert_function, assert_terms, call_user_fun, create_query_data, create_single_dose_dataset, date_source, derivation_slice, derive_extreme_records, derive_param_exist_flag, derive_param_first_event, derive_param_wbc_abs, derive_var_analysis_ratio, derive_var_extreme_dt, derive_var_extreme_dtm, derive_var_merged_cat, derive_var_merged_character, derive_var_merged_exist_flag, derive_var_shift, derive_vars_merged, derive_vars_merged_dt, derive_vars_merged_dtm, dose_freq_lookup, filter_relative, query, restrict_derivation, sdg_select, slice_derivation, smq_select, validate_query, validate_sdg_select and 2 more
  • R
    R 4.2.0 released · 2022-04-22
  • 0.6.3
    record
    2022-02-17
  • R
    R 4.1.0 released · 2021-05-18

Package metadata

First published
2022-02-17
Total releases
31 / 4 yrs
License
Apache License (>= 2)
Minimum R
≥ 4.1
Bundled data
69 KB / 15 files
Download size
1.6 MB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("admiral")
Mancini, E., F. Hoffmann-La Roche AG, GlaxoSmithKline LLC, Bundfuss, S., Cascone, A., Dahnert, K., Dickinson, J., Farrugia, R., Gautier, F., Hobby, L., Miller, G., Patil, L., & Straub, B. (2026). admiral: ADaM in R Asset Library (Version 1.5.0) [Computer software]. https://doi.org/10.32614/CRAN.package.admiral

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for admiral version 1.5.0 [Data set]. HJJB, LLC. Data release v2026-10-18. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy