Skip to content

admiraldev 1.4.0

Choose a tag to compare

@bms63 bms63 released this 14 Jan 16:31
· 32 commits to main since this release

admiraldev 1.4.0

New Features

  • Added custom {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)

Updates of Existing Functions

  • 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)

Breaking Changes

  • 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() instead
    • enumerate() - 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

Documentation

  • 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)

Various

  • Added various unit tests to improve the test coverage of {admiraldev}. (#524)