inst/tests/test-tag.r

In hadley/roxygen3: In-source documentation for R

context("Tag")

test_that("aliases split into pieces", {
  out <- test_process("
    #' @aliases a b
    #' @name a
    NULL")

  expect_match(tag_value(out, "aliases"), fixed("a"), all = FALSE)
  expect_match(tag_value(out, "aliases"), fixed("b"), all = FALSE)
})

test_that("generic keys produce expected output", {
  out <- test_process("
    #' @references test
    #' @note test
    #' @author test
    #' @seealso test
    #' @concept test
    #' @encoding test
    #' @name a
    NULL")
  expect_equal(tag_value(out, "references"), "test")
  expect_equal(tag_value(out, "note"), "test")
  expect_equal(tag_value(out, "seealso"), "test")
  expect_equal(tag_value(out, "concept"), "test")
  expect_equal(tag_value(out, "encoding"), "test")
  expect_equal(tag_value(out, "author"), "test")
})

test_that("other namespace tags produce correct output", {
  out <- test_process("
    #' @import test
    #' @importFrom test test1 test2
    #' @importClassesFrom test test1 test2
    #' @importMethodsFrom test test1 test2
    #' @name dummy
    NULL")

  expect_equal(tag_value(out, "import"), "test")
  expect_equal(tag_value(out, "importFrom"), c("test1" = "test", test2 = "test"))
  expect_equal(tag_value(out, "importClassesFrom"), c("test", "test1", "test2"))
  expect_equal(tag_value(out, "importMethodsFrom"), c("test", "test1", "test2"))
})