tests/testthat/test-roxygen2.R

In admiraldev: Utility Functions and Development Tools for the Admiral Package Family

# roxygen_param_dataset ----
## Test 1: Input dataset standardized text works ----
test_that("roxygen_param_dataset Test 1: Input dataset standardized text works", {
  expect_equal("Input dataset", roxygen_param_dataset(expected_vars = NULL))
})

## Test 2: Input dataset standardized text works with expected_vars ----
test_that("roxygen_param_dataset Test 2: Input dataset standardized text works", {
  expect_equal(
    paste0(
      "Input dataset \n \n",
      "The variables specified by the `by_vars` argument are expected to be in the dataset."
    ),
    roxygen_param_dataset(expected_vars = c("by_vars"))
  )
})

# roxygen_param_by_vars ----
## Test 3: Text variations ----
test_that("roxygen_param_by_vars Test 3: Text variations", {
  expect_snapshot(
    roxygen_param_by_vars()
  )
  expect_snapshot(
    roxygen_param_by_vars(rename = TRUE)
  )
})

# roxygen_order_na_handling ----
## Test 4: Standardized text works ----
test_that("roxygen_order_na_handling Test 4: Standardized text works", {
  expect_equal(
    roxygen_order_na_handling(),
    paste(
      "For handling of `NA`s in sorting variables see the \"Sort Order\" section",
      "in `vignette(\"generic\")`."
    )
  )
})

# roxygen_save_memory ----
## Test 5: Standardized text works ----
test_that("roxygen_save_memory Test 5: Standardized text works", {
  expect_equal(
    roxygen_save_memory(),
    paste(
      "**Note:** This function creates temporary datasets which may be much bigger",
      "than the input datasets. If this causes memory issues, please try setting",
      "the admiral option `save_memory` to `TRUE` (see `set_admiral_options()`).",
      "This reduces the memory consumption but increases the run-time.",
      sep = "\n"
    )
  )
})