Learn R Programming

admiraldev

Utility Functions and Development Tools for the Admiral Package Family

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.

Acknowledgments

Along with the authors and contributors, thanks to the following people for their work on the package: Ania Golab, Samia Kabi, Pooja Kumari, Syed Mubasheer, Thomas Neitmann and Ondrej Slama.

Copy Link

Version

Install

install.packages('admiraldev')

Monthly Downloads

1,459

Version

1.2.0

License

Apache License (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Ben Straub

Last Published

January 15th, 2025

Functions in admiraldev (1.2.0)

assert_numeric_vector

Is an Argument a Numeric Vector?
assert_named

Assert Argument is a Named List or Vector
assert_one_to_one

Is There a One to One Mapping between Variables?
assert_expr_list

Is an Argument a List of Expressions?
assert_function

Is Argument a Function?
assert_integer_scalar

Is an Argument an Integer Scalar?
assert_list_element

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

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

Is an Argument a Logical Scalar (Boolean)?
assert_filter_cond

Is an Argument a Filter Condition?
convert_dtm_to_dtc

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

Expectation: Are Two Datasets Equal?
assert_s3_class

Is an Argument an Object of a Specific S3 Class?
assert_unit

Asserts That a Parameter is Provided in the Expected Unit
contains_vars

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

Is an Argument a Variable-Value List?
assert_param_does_not_exist

Asserts That a Parameter Does Not Exist in the Dataset
backquote

Wrap a String in Backquotes
assert_vars

Is an Argument a List of Variables?
assert_same_type

Are All Argument of the Same Type?
assert_symbol

Is an Argument a Symbol?
enumerate

Enumerate Multiple Elements
friendly_type_of

Return English-friendly messaging for object-types
dataset_vignette

Output a Dataset in a Vignette in the admiral Format
is_order_vars

Is order vars?
is_auto

Checks if the argument equals the auto keyword
filter_if

Optional Filter
dquote

Wrap a String in Double Quotes
get_constant_vars

Get Constant Variables
extract_vars

Extract All Symbols from a List of Expressions
vars2chr

Turn a List of Expressions into a Character Vector
warn_if_incomplete_dtc

Warn if incomplete dtc
get_new_tmp_var

Get a New Temporary Variable Name for a Dataset
%notin%

Negated Value Matching
valid_time_units

Valid Time Units
is_valid_dtc

Is this string a valid DTC
%or%

Or
suppress_warning

Suppress Specific Warnings
squote

Wrap a String in Single Quotes
anti_join

Join Functions
warn_if_vars_exist

Warn If a Variable Already Exists
warn_if_inconsistent_list

Warn If Two Lists are Inconsistent
warn_if_invalid_dtc

Warn If a Vector Contains Unknown Datetime Format
get_source_vars

Get Source Variables from a List of Expressions
expr_c

Concatenate One or More Expressions
replace_symbol_in_expr

Replace Symbols in an Expression
replace_values_by_names

Replace Expression Value with Name
deprecate_inform

Deprecation with Soft Message
what_is_it

What Kind of Object is This?
get_dataset

Retrieve a Dataset from the admiraldev_environment environment
process_set_values_to

Process set_values_to Argument
get_duplicates

Get Duplicates From a Vector
remove_tmp_vars

Remove All Temporary Variables Created Within the Current Function Environment
arg_name

Extract Argument Name from an Expression
assert_character_scalar

Is an Argument a Character Scalar (String)?
assert_date_vector

Is an object a date or datetime vector?
assert_atomic_vector

Is an Argument an Atomic Vector?
assert_character_vector

Is an Argument a Character Vector?
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
assert_expr

Assert Argument is an Expression
assert_date_var

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

Is an Argument a Data Frame?