inst/tests/test-tag-doctype.r

In hadley/roxygen3: In-source documentation for R

context("Tag: @docType")

# Package --------------------------------------------------------------------

test_that("@docType package automatically adds package alias when needed", {
  out1 <- test_process("
    #' @name a
    #' @docType package
    NULL")
  out2 <- test_process("
    #' @name a-package
    #' @docType package
    NULL")

  expect_equal(sort(tag_value(out1, "aliases")), sort(c("a", "a-package")))
  expect_equal(tag_value(out2, "aliases"), c("a-package"))
})


# Data --------------------------------------------------------------------

test_that("@docType data automatically adds sensible defaults", {
  out <- test_process("
    #' Title.
    #'
    #' @docType data
    a <- data.frame(a = 1:10)")

  expect_equal(format(tag(out, "usage")), "a")
  expect_equal(tag_value(out, "keywords"), "datasets")
  expect_match(tag_value(out, "format"), "data\\.frame")
})

test_that("@docType data automatically added to data objects", {
  out <- test_process("
    #' Title.
    a <- data.frame(a = 1:10)")

  expect_equal(tag_value(out, "docType"), "data")
})

# Reference classes ----------------------------------------------------------

test_that("reference classes given docType class", {
  out1 <- test_process("
    #' Title.
    a <- setRefClass('a')")
  out2 <- test_process("
    #' Title.
    setRefClass('a')")

  expect_equal(tag_value(out1, "docType"), "class")
  expect_equal(tag_value(out2, "docType"), "class")
})

# S4 classes ----------------------------------------------------------

test_that("S4 classes given docType class", {
  out1 <- test_process("
    #' Title.
    a <- setClass('a')")
  out2 <- test_process("
    #' Title.
    setClass('a')")

  expect_equal(tag_value(out1, "docType"), "class")
  expect_equal(tag_value(out2, "docType"), "class")
})