ADaM in R Asset Library
Overview
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).
Updates of Existing Functions
derive_vars_dt()andderive_vars_dtm()were enhanced to allow user-defineddate_imputationvalues (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_datesargument 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_varsand thetmp_obs_nr_vararguments were added toevent_joined(). This allows to derive parameters requiring confirmation _by visit_ usingderive_extreme_event(). (#3022)
Show all changes in 1.5.0Hide the rest of the changes in 1.5.0
- The
filter_sourceargument was added toevent_joined(), allowing to
specify a condition to restrict the source dataset before the join, e.g., when
using derive_extreme_event(). (#3033)
- The
filter_addargument inderive_var_joined_exist_flag()is no longer
erroneously ignored. (#3018)
- Poorly formatted warning messages in
derive_param_computed()andderive_vars_computed()were improved. (#2969) - Fixed typo in
derive_summary_records()error message. (#3127) use_ad_template()was updated to remove theopenargument, 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_valuesargument was added toderive_extreme_records(). This allows users to specify values for variables in the new records originating fromdataset_ref. (#3017) list_all_templates()now only lists out.Rfiles with thetemplatesfolder
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_singledataset was removed from{admiral}to reduce the package size. It can be derived on the fly usingcreate_single_dose_dataset(). See theOCCDSvignette or?create_single_dose_datasetfor 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 coveringflag_eventswith multiple
sources, customizing true_value, false_value, and missing_value, and per-source by_vars renaming. (#2906)
- The
UDTCderivation inADPPKwas updated to use source domainDTCvariables. (#3011) - The example for
derive_var_nfrlt()was updated to useNA_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)
- The contribution guidelines for the
{admiral}ecosystem
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 inbasetypesare retained withBASETYPEset toNA. (#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
datasetrefinderive_summary_records(). (#3012) - Usage of
ASEQ(an optional variable) was clarified within the corresponding Vignettes and Templates. (#2986) - The derivation of
DOSEONandDOSEUvariables in the OCCDS vignette was clarified and generalized to cover more scenarios. (#3101) - The documentation for
derive_vars_dtm()andderive_vars_dt()was updated to clarify details of thehighest_imputationargument. (#3055) - The "Date and Time Imputation" vignette was updated to point out the difference between the character
*DTCvariables and the numeric*DTMvariables. (#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}toAGENTS.mdinstruction 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.ymlwas 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(), androxygen_save_memory()have been moved from{admiral}to{admiraldev}. They are now exported from{admiraldev}and remain accessible in{admiral}via the existing@import admiraldevdependency. (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
- 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
Documentation
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
Repository
- 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
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
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.
Show all practicesHide 1 practice
This repository shows signs of AI coding tools.
- GitHub Copilotfirst seen 2025-11-20Pull request: opened by its own accountCommits: 39 by its own account · at least 43 crediting it in the message
- Claude Codefirst seen 2026-07-14Named in .gitignore: CLAUDE.mdPull request it wrote: opened by a project memberCommits: at least 4 crediting it in the message
- Claude CodePull requests: 1 from outside contributors, first on 2026-09-21
- Claude Sonnet 53 commits · Aug to Sep 2026
- Claude Opus 4.81 commit · Jul 2026
Dependencies
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.
Code & Tests
Datasets
People & History
Previously maintained by Ben Straub (0.10.2 to 1.4.1) and Thomas Neitmann (0.6.3 to 0.10.1).
Show 8 of 59 peopleHide 8 people
Pick two releases to compare their code metrics.
- 1.5.0Latest
- 1.4.22026-05-28 · diff ↗
- RR 4.6.0 released · 2026-04-24
- 1.4.12026-02-03 · diff ↗
- 1.4.02026-01-15 · diff ↗ ·
added 3 exports
convert_xxtpt_to_hours, derive_var_nfrlt, derive_vars_merged_summary - 1.3.12025-07-29 · diff ↗
- 1.3.0
- RR 4.5.0 released · 2025-04-11
- 1.2.02025-01-15 · diff ↗ ·
removed 2 exports
country_code_lookup, dose_freq_lookupadded 3 exports
derive_vars_cat, derive_vars_crit_flag, transform_range - 1.1.12024-06-17 · diff ↗
- 1.1.0
- RR 4.4.0 released · 2024-04-24
- 1.0.22024-03-05 · diff ↗
- 1.0.12024-02-02 · diff ↗
- 1.0.02023-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_queryadded 4 exports
derive_var_merged_ef_msrc, derive_vars_computed, derive_vars_extreme_event, flag_event - 0.12.32023-10-18 · diff ↗
Show 21 earlier eventsHide 21 earlier events
- 0.12.22023-10-06 · diff ↗
- 0.12.12023-09-25 · diff ↗
- 0.12.02023-09-12 · diff ↗ ·
removed 5 exports
derive_var_disposition_status, derive_var_worst_flag, derive_vars_disposition_reason, format_eoxxstt_default, format_reason_defaultadded 1 export
event_joined - 0.11.12023-07-06 · diff ↗
- 0.11.02023-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, varsadded 7 exports
compute_age_years, compute_egfr, derive_basetype_records, derive_param_extreme_record, filter_exist, filter_not_exist, records_source - 0.10.22023-04-25 · diff ↗
- RR 4.3.0 released · 2023-04-21
- 0.10.12023-03-14 · diff ↗
- 0.10.02023-03-08 · diff ↗ ·
removed 7 exports
derive_var_ady, derive_var_aendy, derive_var_astdy, derive_var_atirel, derive_vars_suppqual, sdg_select, smq_selectadded 8 exports
compute_scale, consolidate_metadata, derive_expected_records, derive_extreme_event, derive_var_joined_exist_flag, event, exprs, filter_joined - 0.9.12022-12-23 · diff ↗
- 0.9.02022-12-06 · diff ↗ ·
removed 4 exports
filter_if, validate_sdg_select, validate_smq_select, vars2chradded 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.42022-10-14 · diff ↗
- 0.8.32022-10-07 · diff ↗
- 0.8.22022-09-29 · diff ↗
- 0.8.12022-09-21 · diff ↗
- 0.8.02022-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 moreadded 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.12022-07-18 · diff ↗
- 0.7.02022-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, exprsadded 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 - RR 4.2.0 released · 2022-04-22
- 0.6.32022-02-17
- RR 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")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.
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.