Learn R Programming

admiraldev

Utility Functions and Development Tools for the Admiral Package Family

Explore all the other packages in the {admiral} ecosystem to learn more about ADaM programming in R.

Purpose

Functions, tools and documentation for developing core {admiral} and extension package functions. Most functions in {admiraldev} are around testing inputs going into functions. There are also additional quality of life functions/Addins to assist developers of {admiral} or {admiral} extension packages, functions to help with rendering documentation, Developer Guides on developing function and using GitHub, GitHub Actions.

NOTE: This package is not intended for standalone use but rather as a central dependency for {admiral} and its extension packages

Installation

The package is available from CRAN and can be installed by running install.packages("admiraldev").

To install the latest development version of the package directly from GitHub use the following code:

if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

remotes::install_github("pharmaverse/admiraldev")

Release Schedule

{admiraldev} is to be released to CRAN at the same time as an official release of {admiral}. You can find the release schedule for {admiral} packages here.

Copy Link

Version

Install

install.packages('admiraldev')

Monthly Downloads

4,658

Version

1.5.0

License

Apache License (>= 2)

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/pharmaverse/admiraldev/

Homepage

https://pharmaverse.github.io/admiraldev/

Maintainer

Edoardo Mancini

Last Published

June 10th, 2026

Functions in admiraldev (1.5.0)

Get Duplicates From a Vector

get_new_tmp_var

Get a New Temporary Variable Name for a Dataset

dataset_vignette

Output a Dataset in a Vignette in the admiral Format

A Demo Function

Negated Value Matching

Checks if the argument equals the auto keyword

get_source_vars

Get Source Variables from a List of Expressions

Get the content of the @param tag

warn_if_inconsistent_list

Warn If Two Lists are Inconsistent

Roclet Extending the Standard rd Roclet

roxygen_param_by_vars

Standard Text for the by_vars Argument

Wrap a String in Single Quotes

roxygen_save_memory

Standard Note for Memory-Intensive Functions

roxygen_param_dataset

Standard Text for the dataset Argument

warn_if_invalid_dtc

Warn If a Vector Contains Unknown Datetime Format

process_set_values_to

Process set_values_to Argument

warn_if_incomplete_dtc

Warn if incomplete dtc

roxygen_order_na_handling

Standard Text for NA Handling in Sorting Variables

remove_tmp_vars

Remove All Temporary Variables Created Within the Current Function Environment

warn_if_vars_exist

Warn If a Variable Already Exists

suppress_warning

Suppress Specific Warnings

execute_example

Execute Example Code

Extract All Symbols from a List of Expressions

deprecate_inform

Deprecation with Soft Message

convert_dtm_to_dtc

Helper Function to Convert Date (or Date-time) Objects to Characters of dtc Format (-DTC type of variable)

friendly_type_of

Return English-friendly messaging for object-types

transform_examplesx

Transform @caption, @info and @code tags into @examplex tags

Enumerate Multiple Elements

Optional Filter

check that argument contains valid variable(s) created with exprs() or Source Variables from a List of Expressions

Wrap a String in Double Quotes

Is this string a valid DTC?

What Kind of Object is This?

transform_param

Process @permitted and @default tags

get_constant_vars

Get Constant Variables

replace_values_by_names

Replace Expression Value with Name

Turn a List of Expressions into a Character Vector

valid_time_units

Valid Time Units

replace_symbol_in_expr

Replace Symbols in an Expression

add_suffix_to_vars

Add a Suffix to Variables in a List of Expressions

admiraldev-package

admiraldev: Utility Functions and Development Tools for the Admiral Package Family

Extract Argument Name from an Expression

assert_date_var

Is a Variable in a Dataset a Date or Datetime Variable?

assert_atomic_vector

Is an Argument an Atomic Vector?

assert_data_frame

Is an Argument a Data Frame?

assert_date_vector

Is an object a date or datetime vector?

assert_character_scalar

Is an Argument a Character Scalar (String)?

assert_logical_scalar

Is an Argument a Logical Scalar (Boolean)?

Assert Argument is an Expression

assert_integer_scalar

Is an Argument an Integer Scalar?

assert_numeric_vector

Is an Argument a Numeric Vector?

Assert Argument is a Named List or Vector

assert_character_vector

Is an Argument a Character Vector?

assert_function

Is Argument a Function?

assert_one_to_one

Is There a One to One Mapping between Variables?

assert_list_element

Is an Element of a List of Lists/Classes Fulfilling a Condition?

Is an Argument a List of Objects of a Specific S3 Class or Type?

assert_expr_list

Is an Argument a List of Expressions?

assert_filter_cond

Is an Argument a Filter Condition?

capture_message

Captures Messages Preserving the Message Redirection

assert_same_type

Are All Arguments of the Same Type?

Is an Argument a Symbol?

Capture Output and Messages

expect_dfs_equal

Expectation: Are Two Datasets Equal?

assert_s3_class

Is an Argument an Object of a Specific S3 Class?

assert_param_does_not_exist

Asserts That a Parameter Does Not Exist in the Dataset

Concatenate One or More Expressions

Is an Argument a List of Variables?

Wrap a String in Backquotes

assert_varval_list

Is an Argument a Variable-Value List?

Asserts That a Parameter is Provided in the Expected Unit

Retrieve a Dataset from the admiraldev_environment environment