Changelog
Source:NEWS.md
admiraldev (development version)
Breaking Changes
- The following functions are entering the next phase of the deprecation process: (#459)
admiraldev 1.1.0
CRAN release: 2024-06-06
Updates of Existing Functions
Updated
arg_name
parameter inassert_filter_cond
,assert_symbol
, andassert_expr
withgsub("^enexpr\\((\\w+)\\)$", "\\1", rlang::caller_arg(arg))
argument so that error messages return a quoted argument withoutenexpr()
, e.g.filter_add
instead ofenexpr(filter_add)
. (#2404)Error messaging throughout the package have been updated from
rlang::abort()
tocli::cli_abort()
. As a part of the update, each of theassert_*()
functions have new argumentsassert_*(message, arg_name, call, class).
(#367)Warning messaging has also been updated to use cli messaging.
Breaking Changes
renv
and related files have been removed. (#360)No longer exporting
is_named()
function. (#401)pharmaversesdtm
removed as a dependency. (#434)-
As a part of the error messaging update, the following changes were made.
The
assert_s3_class(class)
argument has been renamed toassert_s3_class(cls)
. (#367)Functions
arg_name()
,enumerate()
,what_is_it()
, andfriendly_type_of()
have been deprecated and a warning is returned to any developer using these functions. As these are developer functions (as opposed to functions for typical admiral users), we will use a short deprecation cycle.
admiraldev 1.0.0
CRAN release: 2023-12-15
Updates of Existing Functions
-
assert_function()
now accepts all function arguments if ellipsis,...
is in the function formals (#339)
Breaking Changes
- The following functions have been deprecated from previous admiral versions using the next phase of the deprecation process
assert_function_param()
assert_named_expr()
assert_has_variables()
admiraldev 0.5.0
CRAN release: 2023-09-11
Updates of Existing Functions
- The messaging for
warn_if_invalid_dtc()
was updated to align with what the date/datetime functions inadmiral
currently do. (#316)
Breaking Changes
- The following functions/arguments have been deprecated from previous admiral versions using the next phase of the deprecation process: (#288)
assert_order_vars()
quo_c()
quo_not_missing()
replace_symbol_in_quo()
- The
quosures
argument was replaced by theexpressions
argument inreplace_values_by_names()
,get_source_vars()
, andvars2chr()
. (#288)
-
assert_function_param()
was deprecated in favor ofassert_function()
. (#264) -
assert_named_expr()
was deprecated in favor ofassert_expr_list()
. (#264) -
assert_has_variables()
was deprecated in favor ofassert_data_frame()
. (#264)
Documentation
- Guidance around issues and merging updated (#286)
- Common R CMD troubleshooting made into separate vignette (#286)
- Documentation of
get_dataset()
was improved. (#271) - Minor updates to programming strategy were added (#213, #240, #260)
- Updated unit testing vignette with snapshot testing guidance. (#302)
- Documentation of
friendly_type_of()
was provided (#22) - Minor updates to pull request review guidance were added (#201, #292)
- Documentation of singular versus plural function argument names was added into the programming strategy vignette. Also documentation on the common arguments
missing_value
andmissing_values
was added. (#296) - Documentation highlighting the difference between
set_values_to
andkeep_source_vars
(#318) - List of common arguments was updated (#306)
admiraldev 0.4.0
CRAN release: 2023-06-06
New Features
New function
assert_named()
to check if all elements of an argument are named (#241)New function
assert_expr_list()
to check if an argument is a list of expressions (#241)Added a Report a bug link on
admiraldev
website (#257)
Breaking Changes
assert_order_vars()
was deprecated in favor ofassert_expr_list()
. (#241)-
The following functions have been deprecated from previous admiral versions using the next phase of the deprecation process: (#272)
quo_c()
quo_not_missing()
replace_symbol_in_quo()
The
quosures
argument was replaced by theexpressions
argument inreplace_values_by_names()
.
admiraldev 0.3.0
CRAN release: 2023-03-06
New Features
- New function
process_set_values_to()
for creating the variables specified by theset_value_to
argument and catching errors (#70)
Updates of Existing Functions
- Using testthat3e (testthat 3rd edition) for unit testing. This is stricter in that messages must be addressed and deprecated functions throw errors. (#230)
- Slight boost to test coverage for
dev_utilities
(#102) - Fix datatable styling for documentation (#197)
- The
assert_character_vector()
function gained anamed
argument to check that all elements of the vector are named. (#70) - The
assert_list_of()
function gained anamed
argument to check that all elements of the list are named. (#203) - The
quote_fun
argument ofenumerate()
was extended such thatNULL
can be specified to request no quoting of the elements. (#203) - The
assert_list_of()
function was enhanced such that it also considers the type of the element, e.g., to check if a value is a list of symbols. (#208)
Breaking Changes
- The default value of the
optional
argument inassert_date_vector()
,assert_list_of()
, andassert_s3_class()
was changed fromTRUE
toFALSE
to make the default behavior consistent. (#87) - admiral functions no longer expect list of quosures created by
vars()
but list of expressions created byexprs()
. Thus the following functions and arguments were deprecated:-
quo_c()
andreplace_symbol_in_quo()
- the
quosures
argument inget_source_vars()
,replace_values_by_names()
, andvars2chr()
-
Documentation
- New section in programming strategy regarding comments (#71)
- Removed requirement to add
@author
tags to code scripts from programming strategy, as we will only be tracking authors in the DESCRIPTION file. Authors have been removed from function documentation in line with this update. (#206, #210) - Removed On-boarding Issue Template (#225)
- Increased clarity for the scope of the package (#232)
admiraldev 0.2.0
CRAN release: 2022-11-30
New Features
- Developer addin for formatting tests to admiral programming standards (#73)
- New functions
replace_symbol_in_quo()
andadd_suffix_to_vars()
(#106) - New function
assert_atomic_vector()
(#98) - New keyword/family
create_aux
for functions creating auxiliary datasets (#126) - New function
assert_date_vector()
(#129) - New function
assert_same_type()
(#176) - Remove dependency on
{assertthat}
(#149) - Test coverage for
admiraldev
have increased from 45% to approximately 100% (#94, #95, #96, #98, #101, #103) -
Environment objects were consolidated into a single
admiraldev_environment
object underR/admiraldev_environment.R
. (#179)
Updates of Existing Functions
-
expect_names
argument added toassert_vars()
to check if all variables are named (#117) - Remove
dplyr
function exports and migration of user facing functionnegate_vars()
to admiral (#83)
admiraldev 0.1.0
CRAN release: 2022-08-26
New Features
- Developer specific functions brought over from admiral
- Developer specific vignettes brought over from admiral
- New admiraldev website created