diff --git a/DESCRIPTION b/DESCRIPTION index d6ec589a..93bc010e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -13,10 +13,9 @@ Authors@R: c( person("F. Hoffmann-La Roche AG", role = c("cph", "fnd")), person("GlaxoSmithKline LLC", role = c("cph", "fnd")) ) -Description: A toolbox for developers working on admiral packages. - Package contains functions that are used internally to admiral and admiral extension packages to - check data, variables and conditions. Package also contains utility functions to help developer with - documentation, testing and general upkeep of admiral and admiral extension packages. +Description: Utility functions to check data, variables and conditions for functions used in + 'admiral' and 'admiral' extension packages. Additional utility helper functions to to assist developers + with maintaining documentation, testing and general upkeep of 'admiral' and 'admiral' extension packages. License: Apache License (>= 2) URL: https://pharmaverse.github.io/admiraldev/main/, https://github.com/pharmaverse/admiraldev/ Encoding: UTF-8 diff --git a/R/expect_dfs_equal.R b/R/expect_dfs_equal.R index 2003058d..8e9d49f2 100644 --- a/R/expect_dfs_equal.R +++ b/R/expect_dfs_equal.R @@ -18,12 +18,11 @@ #' @export #' #' @examples -#' \dontrun{ -#' testthat::test_that("a missing row is detected", { -#' data(dm) -#' expect_dfs_equal(dm, dm[-1L, ], keys = "USUBJID") -#' }) -#' } +#' library(admiral.test) +#' \donttest{(testthat::test_that("a missing row is detected", { +#' data(admiral_dm) +#' expect_dfs_equal(admiral_dm, admiral_dm[-1L, ], keys = "USUBJID") +#' })} expect_dfs_equal <- function(base, compare, keys, ...) { diff <- diffdf::diffdf(base, compare, keys, suppress_warnings = TRUE, ...) if (diffdf::diffdf_has_issues(diff)) { diff --git a/man/admiraldev-package.Rd b/man/admiraldev-package.Rd index 74e0ef04..f8c998cf 100644 --- a/man/admiraldev-package.Rd +++ b/man/admiraldev-package.Rd @@ -8,7 +8,7 @@ \description{ \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} -A toolbox for developers working on admiral packages. Package contains functions that are used internally to admiral and admiral extension packages to check data, variables and conditions. Package also contains utility functions to help developer with documentation, testing and general upkeep of admiral and admiral extension packages. +Utility functions to check data, variables and conditions for functions used in 'admiral' and 'admiral' extension packages. Additional utility helper functions to to assist developers with maintaining documentation, testing and general upkeep of 'admiral' and 'admiral' extension packages. } \seealso{ Useful links: diff --git a/man/expect_dfs_equal.Rd b/man/expect_dfs_equal.Rd index fa133edd..ab4135db 100644 --- a/man/expect_dfs_equal.Rd +++ b/man/expect_dfs_equal.Rd @@ -23,12 +23,11 @@ An error if \code{base} and \code{compare} do not match or \code{NULL} invisibly Uses \code{\link[diffdf:diffdf]{diffdf::diffdf()}} to compares 2 datasets for any differences } \examples{ -\dontrun{ -testthat::test_that("a missing row is detected", { - data(dm) - expect_dfs_equal(dm, dm[-1L, ], keys = "USUBJID") -}) -} +library(admiral.test) +\donttest{(testthat::test_that("a missing row is detected", { + data(admiral_dm) + expect_dfs_equal(admiral_dm, admiral_dm[-1L, ], keys = "USUBJID") +})} } \author{ Thomas Neitmann