Man pages for admiraldev
Utility Functions and Development Tools for the Admiral Package Family

add_suffix_to_varsAdd a Suffix to Variables in a List of Expressions
admiraldev-packageadmiraldev: Utility Functions and Development Tools for the...
arg_nameExtract Argument Name from an Expression
assert_atomic_vectorIs an Argument an Atomic Vector?
assert_character_scalarIs an Argument a Character Scalar (String)?
assert_character_vectorIs an Argument a Character Vector?
assert_data_frameIs an Argument a Data Frame?
assert_date_varIs a Variable in a Dataset a Date or Datetime Variable?
assert_date_vectorIs an object a date or datetime vector?
assert_exprAssert Argument is an Expression
assert_expr_listIs an Argument a List of Expressions?
assert_filter_condIs an Argument a Filter Condition?
assert_functionIs Argument a Function?
assert_integer_scalarIs an Argument an Integer Scalar?
assert_list_elementIs an Element of a List of Lists/Classes Fulfilling a...
assert_list_ofIs an Argument a List of Objects of a Specific S3 Class or...
assert_logical_scalarIs an Argument a Logical Scalar (Boolean)?
assert_namedAssert Argument is a Named List or Vector
assert_numeric_vectorIs an Argument a Numeric Vector?
assert_one_to_oneIs There a One to One Mapping between Variables?
assert_param_does_not_existAsserts That a Parameter Does Not Exist in the Dataset
assert_s3_classIs an Argument an Object of a Specific S3 Class?
assert_same_typeAre All Arguments of the Same Type?
assert_symbolIs an Argument a Symbol?
assert_unitAsserts That a Parameter is Provided in the Expected Unit
assert_varsIs an Argument a List of Variables?
assert_varval_listIs an Argument a Variable-Value List?
backquoteWrap a String in Backquotes
capture_messageCaptures Messages Preserving the Message Redirection
capture_outputCapture Output and Messages
contains_varscheck that argument contains valid variable(s) created with...
convert_dtm_to_dtcHelper Function to Convert Date (or Date-time) Objects to...
dataset_vignetteOutput a Dataset in a Vignette in the admiral Format
demo_funA Demo Function
deprecate_informDeprecation with Soft Message
dquoteWrap a String in Double Quotes
enumerateEnumerate Multiple Elements
execute_exampleExecute Example Code
expect_dfs_equalExpectation: Are Two Datasets Equal?
expr_cConcatenate One or More Expressions
extract_varsExtract All Symbols from a List of Expressions
filter_ifOptional Filter
friendly_type_ofReturn English-friendly messaging for object-types
get_constant_varsGet Constant Variables
get_datasetRetrieve a Dataset from the 'admiraldev_environment'...
get_duplicatesGet Duplicates From a Vector
get_new_tmp_varGet a New Temporary Variable Name for a Dataset
get_param_tagGet the content of the @param tag
get_source_varsGet Source Variables from a List of Expressions
grapes-notin-grapesNegated Value Matching
grapes-or-grapesOr
is_autoChecks if the argument equals the auto keyword
is_order_varsIs order vars?
is_valid_dtcIs this string a valid DTC
joinsJoin Functions
parse_codeParse Code
process_set_values_toProcess 'set_values_to' Argument
rdx_rocletRoclet Extending the Standard rd Roclet
remove_tmp_varsRemove All Temporary Variables Created Within the Current...
replace_symbol_in_exprReplace Symbols in an Expression
replace_values_by_namesReplace Expression Value with Name
squoteWrap a String in Single Quotes
suppress_warningSuppress Specific Warnings
transform_examplesxTransform @caption, @info and @code tags into @examplex tags
transform_paramProcess @permitted and @default tags
valid_time_unitsValid Time Units
vars2chrTurn a List of Expressions into a Character Vector
warn_if_incomplete_dtcWarn if incomplete dtc
warn_if_inconsistent_listWarn If Two Lists are Inconsistent
warn_if_invalid_dtcWarn If a Vector Contains Unknown Datetime Format
warn_if_vars_existWarn If a Variable Already Exists
what_is_itWhat Kind of Object is This?
admiraldev documentation built on June 26, 2025, 1:09 a.m.