inst/tinytest/test_delim.R

In formatdown: Formatting Numbers in 'rmarkdown' Documents

test_delim <- function() {

  # Option: delim
  #         format_numbers()
  #         format_sci()
  #         format_engr()
  #         format_dcml()
  #         format_text()

  # Possible values are
  #         "$"
  #         c("$", "$")
  #         "\("
  #         c("\\(", "\\)")
  #         c(<left_marker>, <right_marker>) user-defined

  # correct behaviors
  x <- 6.0221e+23

  ans101 <- "$602.2 \\times 10^{21}$"
  expect_equal(ans101, format_numbers(x))
  expect_equal(ans101, format_numbers(x, delim = "$"))
  expect_equal(ans101, format_numbers(x, delim = c("$", "$")))
  expect_equal(ans101, format_engr(x))
  expect_equal(ans101, format_engr(x, delim = "$"))
  expect_equal(ans101, format_engr(x, delim = c("$", "$")))

  ans102 <- "\\(602.2 \\times 10^{21}\\)"
  expect_equal(ans102, format_numbers(x, delim = "\\("))
  expect_equal(ans102, format_numbers(x, delim = c("\\(", "\\)")))
  expect_equal(ans102, format_engr(x, delim = "\\("))
  expect_equal(ans102, format_engr(x, delim = c("\\(", "\\)")))

  ans103 <- "\\[602.2 \\times 10^{21}\\]"
  expect_equal(ans103, format_numbers(x, delim = c("\\[", "\\]")))
  expect_equal(ans103, format_engr(x, delim = c("\\[", "\\]")))

  ans104 <- "$6.022 \\times 10^{23}$"
  expect_equal(ans104, format_sci(x))
  expect_equal(ans104, format_sci(x, delim = "$"))
  expect_equal(ans104, format_sci(x, delim = c("$", "$")))

  ans105 <- "\\(6.022 \\times 10^{23}\\)"
  expect_equal(ans105, format_sci(x, delim = "\\("))
  expect_equal(ans105, format_sci(x, delim = c("\\(", "\\)")))

  ans106 <- "\\[6.022 \\times 10^{23}\\]"
  expect_equal(ans106, format_sci(x, delim = c("\\[", "\\]")))

  x <- 987123

  ans107 <- "$987100$"
  expect_equal(ans107, format_dcml(x))
  expect_equal(ans107, format_dcml(x, delim = "$"))
  expect_equal(ans107, format_dcml(x, delim = c("$", "$")))

  ans108 <- "\\(987100\\)"
  expect_equal(ans108, format_dcml(x, delim = "\\("))
  expect_equal(ans108, format_dcml(x, delim = c("\\(", "\\)")))

  ans109 <- "\\[987100\\]"
  expect_equal(ans109, format_dcml(x, delim = c("\\[", "\\]")))

  x <- 6.0221e+23
  units(x) <- "m"

  ans110 <- "$602.2 \\times 10^{21}\\>\\mathrm{m}$"
  expect_equal(ans110, format_numbers(x))
  expect_equal(ans110, format_numbers(x, delim = "$"))
  expect_equal(ans110, format_numbers(x, delim = c("$", "$")))

  ans111 <- "\\(602.2 \\times 10^{21}\\>\\mathrm{m}\\)"
  expect_equal(ans111, format_numbers(x, delim = "\\("))
  expect_equal(ans111, format_numbers(x, delim = c("\\(", "\\)")))

  ans112 <- "\\[602.2 \\times 10^{21}\\>\\mathrm{m}\\]"
  expect_equal(ans112, format_numbers(x, delim = c("\\[", "\\]")))

  x <- "hello world"

  ans113 <- "$\\mathrm{hello\\>world}$"
  expect_equal(ans113, format_text(x))
  expect_equal(ans113, format_text(x, delim = "$"))
  expect_equal(ans113, format_text(x, delim = c("$", "$")))

  ans114 <- "\\(\\mathrm{hello\\>world}\\)"
  expect_equal(ans114, format_text(x, delim = "\\("))
  expect_equal(ans114, format_text(x, delim = c("\\(", "\\)")))

  ans115 <- "\\[\\mathrm{hello\\>world}\\]"
  expect_equal(ans115, format_text(x, delim = c("\\[", "\\]")))

  # vector input
  x <- c(123, 4.56e+11)
  ans116 <- c("\\(123\\)", "\\(456 \\times 10^{9}\\)")
  expect_equal(ans116, format_numbers(x, 3, delim = "\\("))

  # errors
  expect_error(format_numbers(x, delim = c("\\[")))
  expect_error(format_numbers(x, delim = c(NA_character_, NA_character_)))
  expect_error(format_numbers(x, delim = c(NULL, NULL)))

  # function output not printed
  invisible(NULL)
}

test_delim()