Package: admiraldev 1.1.0.9006

Ben Straub

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

Utility functions to check data, variables and conditions for functions used in 'admiral' and 'admiral' extension packages. Additional utility helper functions to assist developers with maintaining documentation, testing and general upkeep of 'admiral' and 'admiral' extension packages.

Authors:Ben Straub [aut, cre], Stefan Bundfuss [aut], Jeffrey Dickinson [aut], Ross Farrugia [aut], Fanny Gautier [aut], Edoardo Mancini [aut], Sadchla Mascary [aut], Gordon Miller [aut], Daniel Sjoberg [aut], Stefan Thoma [aut], Kangjie Zhang [aut], Zelos Zhu [aut], F. Hoffmann-La Roche AG [cph, fnd], GlaxoSmithKline LLC [cph, fnd]

admiraldev_1.1.0.9006.tar.gz
admiraldev_1.1.0.9006.zip(r-4.5)admiraldev_1.1.0.9006.zip(r-4.4)admiraldev_1.1.0.9006.zip(r-4.3)
admiraldev_1.1.0.9006.tgz(r-4.4-any)admiraldev_1.1.0.9006.tgz(r-4.3-any)
admiraldev_1.1.0.9006.tar.gz(r-4.5-noble)admiraldev_1.1.0.9006.tar.gz(r-4.4-noble)
admiraldev_1.1.0.9006.tgz(r-4.4-emscripten)admiraldev_1.1.0.9006.tgz(r-4.3-emscripten)
admiraldev.pdf |admiraldev.html✨
admiraldev/json (API)
NEWS

# Install 'admiraldev' in R:
install.packages('admiraldev', repos = c('https://ddsjoberg.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/pharmaverse/admiraldev/issues

On CRAN:

10.98 score 17 stars 7 packages 195 scripts 1.3k downloads 63 exports 23 dependencies

Last updated 14 days agofrom:f40491af1d. Checks:OK: 5 NOTE: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKNov 07 2024
R-4.5-winNOTENov 07 2024
R-4.5-linuxNOTENov 08 2024
R-4.4-winOKNov 07 2024
R-4.4-macOKNov 07 2024
R-4.3-winOKNov 07 2024
R-4.3-macOKNov 07 2024

Exports:%notin%%or%add_suffix_to_varsanti_joinarg_nameassert_atomic_vectorassert_character_scalarassert_character_vectorassert_data_frameassert_date_varassert_date_vectorassert_exprassert_expr_listassert_filter_condassert_functionassert_integer_scalarassert_list_elementassert_list_ofassert_logical_scalarassert_namedassert_numeric_vectorassert_one_to_oneassert_param_does_not_existassert_s3_classassert_same_typeassert_symbolassert_unitassert_varsassert_varval_listbackquotecontains_varsconvert_dtm_to_dtcdataset_vignettedquoteenumerateexpect_dfs_equalexpr_cextract_varsfilter_iffriendly_type_ofget_constant_varsget_datasetget_duplicatesget_new_tmp_varget_source_varsinner_joinis_autois_order_varsis_valid_dtcleft_joinprocess_set_values_toremove_tmp_varsreplace_symbol_in_exprreplace_values_by_namessquotesuppress_warningvalid_time_unitsvars2chrwarn_if_incomplete_dtcwarn_if_inconsistent_listwarn_if_invalid_dtcwarn_if_vars_existwhat_is_it

Dependencies:clicpp11dplyrfansigenericsgluelifecyclelubridatemagrittrpillarpkgconfigpurrrR6rlangstringistringrtibbletidyrtidyselecttimechangeutf8vctrswithr

Get Started

Rendered fromadmiraldev.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-05-15
Started: 2022-08-08

Package Extensions

Rendered frompackage_extensions.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-06-03
Started: 2023-09-10

R CMD Issues

Rendered fromrcmd_issues.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2023-09-10
Started: 2023-09-10

Test Data Guidance

Rendered fromtest_data_guidance.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-06-03
Started: 2023-09-10

Readme and manuals

Help Manual

Help pageTopics
Negated Value Matching%notin%
Or%or%
Add a Suffix to Variables in a List of Expressionsadd_suffix_to_vars
Join Functionsanti_join inner_join left_join
Extract Argument Name from an Expressionarg_name
Is an Argument an Atomic Vector?assert_atomic_vector
Is an Argument a Character Scalar (String)?assert_character_scalar
Is an Argument a Character Vector?assert_character_vector
Is an Argument a Data Frame?assert_data_frame
Is a Variable in a Dataset a Date or Datetime Variable?assert_date_var
Is an object a date or datetime vector?assert_date_vector
Assert Argument is an Expressionassert_expr
Is an Argument a List of Expressions?assert_expr_list
Is an Argument a Filter Condition?assert_filter_cond
Is Argument a Function?assert_function
Is an Argument an Integer Scalar?assert_integer_scalar
Is an Element of a List of Lists/Classes Fulfilling a Condition?assert_list_element
Is an Argument a List of Objects of a Specific S3 Class or Type?assert_list_of
Is an Argument a Logical Scalar (Boolean)?assert_logical_scalar
Assert Argument is a Named List or Vectorassert_named
Is an Argument a Numeric Vector?assert_numeric_vector
Is There a One to One Mapping between Variables?assert_one_to_one
Asserts That a Parameter Does Not Exist in the Datasetassert_param_does_not_exist
Is an Argument an Object of a Specific S3 Class?assert_s3_class
Are All Argument of the Same Type?assert_same_type
Is an Argument a Symbol?assert_symbol
Asserts That a Parameter is Provided in the Expected Unitassert_unit
Is an Argument a List of Variables?assert_vars
Is an Argument a Variable-Value List?assert_varval_list
Wrap a String in Backquotesbackquote
check that argument contains valid variable(s) created with 'exprs()' or Source Variables from a List of Expressionscontains_vars
Helper Function to Convert Date (or Date-time) Objects to Characters of dtc Format (-DTC type of variable)convert_dtm_to_dtc
Output a Dataset in a Vignette in the admiral Formatdataset_vignette
Wrap a String in Double Quotesdquote
Enumerate Multiple Elementsenumerate
Expectation: Are Two Datasets Equal?expect_dfs_equal
Concatenate One or More Expressionsexpr_c
Extract All Symbols from a List of Expressionsextract_vars
Optional Filterfilter_if
Return English-friendly messaging for object-typesfriendly_type_of
Get Constant Variablesget_constant_vars
Retrieve a Dataset from the 'admiraldev_environment' environmentget_dataset
Get Duplicates From a Vectorget_duplicates
Get a New Temporary Variable Name for a Datasetget_new_tmp_var
Get Source Variables from a List of Expressionsget_source_vars
Checks if the argument equals the auto keywordis_auto
Is order vars?is_order_vars
Is this string a valid DTCis_valid_dtc
Process 'set_values_to' Argumentprocess_set_values_to
Remove All Temporary Variables Created Within the Current Function Environmentremove_tmp_vars
Replace Symbols in an Expressionreplace_symbol_in_expr
Replace Expression Value with Namereplace_values_by_names
Wrap a String in Single Quotessquote
Suppress Specific Warningssuppress_warning
Valid Time Unitsvalid_time_units
Turn a List of Expressions into a Character Vectorvars2chr
Warn if incomplete dtcwarn_if_incomplete_dtc
Warn If Two Lists are Inconsistentwarn_if_inconsistent_list
Warn If a Vector Contains Unknown Datetime Formatwarn_if_invalid_dtc
Warn If a Variable Already Existswarn_if_vars_exist
What Kind of Object is This?what_is_it