{admiral} linter configuration function
admiral_linters() under inst/lintr/linters.R
to enable consistent lint programming standards across the
{admiral} family of packages. New configurations include,
for instance, enforcing the use of cli::cli_abort() over
stop() and enforcing the use of
cli::cli_warn() over warning(). (#506)The rdx_roclet() was updated such that it no longer
fails if the documentation contains an R6 class. (#512)
assert_data_frame() was enhanced with the addition
of a new argument check_is_rowwise which checks whether the
input dataset is rowwise. This is set as TRUE by default,
so may constitute a breaking change if rowwise datasets were being
passed to assert_data_frame(). (#475)
Removed custom join functions (anti_join(),
inner_join(), left_join()) from
{admiraldev}. These functions were originally created to
suppress warnings about different attributes on LHS and RHS of joins.
With {dplyr} >= 1.1.1, this warning is no longer issued,
making these wrapper functions redundant. Users should now use the
standard {dplyr} join functions directly. The minimum
required version of {dplyr} has been updated from 1.0.5 to
1.1.1. (#530)
The following function arguments are entering the next phase of the deprecation process: (#2487) (#2595)
Phase 1 (message)
%or% - Please get in touch if you are using this
function!valid_time_units() - Please get in touch if you are
using this function!Phase 2 (warning)
No functions or arguments in this Phase
Phase 3 (error)
arg_name() - Use rlang::caller_arg()
insteadenumerate() - Use cli functionality
instead, e.g., cli::cli_abort('{.val {letters[1:3]}}')what_is_it() - Use cli functionality
instead, e.g.,
cli::cli_abort('{.obj_type_friendly {letters}}')friendly_type_of() - Use cli functionality
instead, e.g.,
cli::cli_abort('{.obj_type_friendly {letters}}')Phase 4 (removed)
No functions or arguments in this Phase
Added the “Ask AI” widget to the the bottom right of each page.
It enables users to ask questions about {admiraldev} and
the rest of the {admiral} ecosystem and receive answers
from an LLM. It is trained on the documentation of all
{admiral} packages and provided by kapa.ai.
(#120)
Added a new “Writing Custom Examples” vignette containing
directives on how to build the “Examples” sections for functions which
use the custom rdx_roclet(). (#503)
The “Release Strategy” vignette was updated to remove inconsistencies in the “Hot Fix Release section”, and to improve its formatting. (#365)
Added a note to the “Writing Vignettes” vignette to encourage users to include the full title of all linked resources to ensure that resources can be found if links become defunct or broken. (#463)
Removed use of CODEOWNERS and discussion in Pull Request Guidance (#486)
{admiraldev}. (#524)The rdx_roclet() extends the standard
{roxygen2} roclet by the @permitted and
@default tags to specify the permitted and default values
and the @caption, @info, and
@code tags for examples with a caption and a description.
(#484)
replace_symbol_in_expr() and
add_suffix_to_vars() no longer fail if the expression
contains NA. (#490)
The following function arguments are entering the next phase of the deprecation process: (#2487) (#2595)
Phase 1 (message)
Phase 2 (warning)
Phase 3 (error)
Phase 4 (removed)
deprecate_inform() is a wrapper around
lifecycle::deprecate_soft() to allow for more control over
messaging. (#466)Objects passed to assert_list_element() via the
... argument can now be used in the glue expression
specified for the message_text argument. (#469)
The required_unit argument of
assert_unit() has been enhanced. It is now possible to
specify more than one unit or not specify it at all. In the latter case
only the uniqueness of the unit is checked. (#468)
The assert_numeric_vector() function gained an
optional length argument to check whether the vector has a
specific length. (#473)
{admiraldev} is only compatible with R version
>=4.1 (#456)
The following function arguments are entering the next phase of the deprecation process: (#459)
Phase 1 (message)
No functions or arguments in this Phase
Phase 2 (warning)
No functions or arguments in this Phase
Phase 3 (error)
No functions or arguments in this Phase
Phase 4 (removed)
quosures was removed in the functions
vars2chr(quosures),
replace_values_by_names(quosures), and
get_source_vars(quosures)assert_named_expr()assert_has_variables()assert_function_param()devcontainer files removed (#480)Updated arg_name parameter in
assert_filter_cond, assert_symbol, and
assert_expr with
gsub("^enexpr\\((\\w+)\\)$", "\\1", rlang::caller_arg(arg))
argument so that error messages return a quoted argument without
enexpr(), e.g. filter_add instead of
enexpr(filter_add). (#2404)
Error messaging throughout the package have been updated from
rlang::abort() to cli::cli_abort(). As a part
of the update, each of the assert_*() functions have new
arguments assert_*(message, arg_name, call, class).
(#367)
Warning messaging has also been updated to use {cli}
messaging.
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
to assert_s3_class(cls). (#367)
Functions arg_name(), enumerate(),
what_is_it(), and friendly_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.
The “Release Strategy” vignette was updated with respect to the new branching strategy. (#353)
The “Release Strategy” vignette now contains a short new “Release Tracking” section linking to an external dashboard for CRAN packages that are awaiting release. (#358)
Removed dependencies not needed to build package or package documentation. (#426)
Increased minimum R version required to 4.0 to match {admiral}. (#382)
addin_format_testthat addin has been moved to
{pharmaverse4devs} package. (#419)
assert_function() now accepts all function arguments if
ellipsis, ... is in the function formals (#339)assert_function_param()assert_named_expr()assert_has_variables()admiral.test have been swapped with
pharmaversesdtm (#321)warn_if_invalid_dtc() was updated to
align with what the date/datetime functions in admiral
currently do. (#316)assert_order_vars()quo_c()quo_not_missing()replace_symbol_in_quo()quosures argument was replaced by the
expressions argument in
replace_values_by_names(), get_source_vars(),
and vars2chr(). (#288)assert_function_param() was deprecated in favor of
assert_function(). (#264)assert_named_expr() was deprecated in favor of
assert_expr_list(). (#264)assert_has_variables() was deprecated in favor of
assert_data_frame(). (#264)get_dataset() was improved.
(#271)friendly_type_of() was provided
(#22)missing_value and
missing_values was added. (#296)set_values_to and keep_source_vars (#318)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)
assert_order_vars() was deprecated in favor of
assert_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 the
expressions argument in
replace_values_by_names().
The deprecation strategy was updated regarding unit tests for deprecated functions/arguments in phase 1. (#247)
The programming strategy was updated regarding permitted values and calling functions from package dependencies (#72, #253)
process_set_values_to() for creating the
variables specified by the set_value_to argument and
catching errors (#70)dev_utilities
(#102)assert_character_vector() function gained a
named argument to check that all elements of the vector are
named. (#70)assert_list_of() function gained a
named argument to check that all elements of the list are
named. (#203)quote_fun argument of enumerate() was
extended such that NULL can be specified to request no
quoting of the elements. (#203)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)optional argument in
assert_date_vector(), assert_list_of(), and
assert_s3_class() was changed from TRUE to
FALSE to make the default behavior consistent. (#87)vars() but list of expressions created by
exprs(). Thus the following functions and arguments were
deprecated:
quo_c() and replace_symbol_in_quo()quosures argument in
get_source_vars(), replace_values_by_names(),
and vars2chr()@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)replace_symbol_in_quo() and
add_suffix_to_vars() (#106)assert_atomic_vector() (#98)create_aux for functions creating
auxiliary datasets (#126)assert_date_vector() (#129)assert_same_type() (#176){assertthat} (#149)admiraldev have increased from 45% to
approximately 100% (#94, #95, #96, #98, #101, #103)admiraldev_environment object under
R/admiraldev_environment.R. (#179)expect_names argument added to
assert_vars() to check if all variables are named
(#117)dplyr function exports and migration of user
facing function negate_vars() to admiral (#83)subject_keys (#133){admiral}{admiral}{admiraldev} website created
Need a high-speed mirror for your open-source project?
Contact our mirror admin team at info@clientvps.com.
This archive is provided as a free public service to the community.
Proudly supported by infrastructure from VPSPulse , RxServers , BuyNumber , UnitVPS , OffshoreName and secure payment technology by ArionPay.