tests/testthat/test-read-textgrid.R

In readtextgrid: Read in a 'Praat' 'TextGrid' File

test_that("reading in point tiers", {
  path <- testthat::test_path("test-data/points.TextGrid")
  tg <- read_textgrid(path)
  expect_equal(nrow(tg), 3)

  # Validate against v1 and pure-r version
  tg2 <- legacy_read_textgrid(path)
  expect_equal(tg, tg2)
  tg3 <- r_read_textgrid(path)
  expect_equal(tg, tg3)
})

test_that("reading in empty point tiers", {
  path <- testthat::test_path("test-data/Mary_John_bell.TextGrid")
  tg <- read_textgrid(path)
  expect_equal(nrow(tg), 3)

  # Validate against v1 and pure-r version
  tg2 <- legacy_read_textgrid(path)
  expect_equal(tg, tg2)
  tg3 <- r_read_textgrid(path)
  expect_equal(tg, tg3)
})

test_that("result is a tibble", {
  path <- testthat::test_path("test-data/Mary_John_bell.TextGrid")
  tg <- read_textgrid(path)
  testthat::expect_s3_class(tg, "tbl")
})

test_that("we can parse numbers supported by Praat.exe", {
  # Files here are minimal tests for numbers that can be parsed by Praat.exe.
  # We need to match what Praat.exe supports, not what they say they support.
  path <- testthat::test_path("test-data/praat-test/okay-digit-dot-space.TextGrid")
  # if (interactive()) writeLines(readLines(path))
  tg <- read_textgrid(path)
  expect_equal(tg$xmax, 1.0)

  path <- testthat::test_path("test-data/praat-test/okay-plus-digit-or-minus-digit.TextGrid")
  # if (interactive()) writeLines(readLines(path))
  tg <- read_textgrid(path)
  expect_equal(tg$tier_xmin, -0.3)
  expect_equal(tg$tier_xmax, 2.0)

  path <- testthat::test_path("test-data/praat-test/okay-scientific-notation.TextGrid")
  # if (interactive()) writeLines(readLines(path))
  tg <- read_textgrid(path)
  expect_equal(tg$tier_xmin, c(0, 0, 0))
  expect_equal(tg$tier_xmax, c(20, 20, 20))
  expect_equal(tg$xmin, c(0, 0.5, 10))
  expect_equal(tg$xmax, c(0.5, 10, 20))

  path <- testthat::test_path("test-data/praat-test/okay-hex-numbers.TextGrid")
  # if (interactive()) writeLines(readLines(path))
  tg <- read_textgrid(path)
  expect_equal(tg$tier_xmin, c(0, 0, 0, 0))
  expect_equal(tg$tier_xmax, c(3, 3, 3, 3))
  expect_equal(tg$xmin, c(0, 0.5, 1.5, 2.5))
  expect_equal(tg$xmax, c(0.5, 1.5, 2.5, 3))

  path <- testthat::test_path("test-data/praat-test/okay-real-with-trailing-characters.TextGrid")
  # if (interactive()) writeLines(readLines(path))
  tg <- read_textgrid(path)
  expect_equal(tg$tier_xmin, c(0, 0, 0))
  expect_equal(tg$tier_xmax, c(20, 20, 20))
  expect_equal(tg$xmin, c(0, 0.5, 10))
  expect_equal(tg$xmax, c(0.5, 10, 20))
})

test_that("example_textgrid works", {
  path <- example_textgrid()
  tg <- read_textgrid(path)
  expect_equal(nrow(tg), 3)

  # Validate against v1 and pure-r version
  tg2 <- legacy_read_textgrid(path)
  expect_equal(tg, tg2)
  tg3 <- r_read_textgrid(path)
  expect_equal(tg, tg3)
})

test_that("comment textgrid works", {
  path <- testthat::test_path("test-data/comment.TextGrid")
  tg <- read_textgrid(path)
  testthat::expect_s3_class(tg, "tbl")
  expect_equal(nrow(tg), 3)
})

test_that("short format textgrid works", {
  path <- testthat::test_path("test-data/short.TextGrid")
  tg <- read_textgrid(path)
  testthat::expect_s3_class(tg, "tbl")
  expect_equal(nrow(tg), 3)
})

test_that("escaped quotes (\"\") are converted to single (\")", {
  path <- testthat::test_path("test-data/quoted.TextGrid")
  tg <- read_textgrid(path)
  has_double <- any(grepl('""', tg$text))
  has_single <- any(grepl('"', tg$text))
  expect_false(has_double)
  expect_true(has_single)

  # Validate against v1 and pure-r version
  tg2 <- legacy_read_textgrid(path)
  expect_equal(tg, tg2)
  tg3 <- r_read_textgrid(path)
  expect_equal(tg, tg3)
})

test_that("can read in hard-to-parse file", {
  path <- testthat::test_path("test-data/hard-to-parse.TextGrid")
  tg <- read_textgrid(path)

  # Validate against pure r
  tg4 <- r_read_textgrid(path)
  tg4$file <- "hard-to-parse.TextGrid"
  expect_equal(tg, tg4)

  # a version of the TextGrid opened and saved by Praat to a long TextGrid
  path2 <- testthat::test_path("test-data/hard-to-parse-normalized.TextGrid")
  tg2 <- read_textgrid(path2)
  tg2$file <- "hard-to-parse.TextGrid"
  expect_equal(tg, tg2)

  # Validate against v1 opening the normalized version
  tg3 <- legacy_read_textgrid(path2)
  tg3$file <- "hard-to-parse.TextGrid"
  expect_equal(tg, tg3)
})



test_that("encoding support", {
  example_textgrid(1) |>
    read_textgrid(encoding = "UTF-8") |>
    nrow() |>
    expect_equal(3)

  example_textgrid(1) |>
    read_textgrid() |>
    nrow() |>
    expect_equal(3)

  example_textgrid(2) |>
    read_textgrid(encoding = "UTF-16") |>
    nrow() |>
    expect_equal(3)

  example_textgrid(2) |>
    read_textgrid() |>
    nrow() |>
    expect_equal(3)
})

test_that("reading in ELAN-generated textgrids (#11)", {
  path <- testthat::test_path("test-data/elan.TextGrid")

  path |>
    read_textgrid() |>
    nrow() |>
    expect_equal(5)
})

test_that("pivoting words on a single tier", {
  path <- testthat::test_path("test-data/nested-intervals.TextGrid")

  data <- path |>
    read_textgrid()

  p1 <- data |> pivot_textgrid_tiers("utterance")
  expect_equal(p1$utterance, "hug daddy")

  p1 |>
    hasName(c("utterance_xmin", "utterance_xmid", "utterance_xmax")) |>
    all() |>
    expect_true()

  data |>
    pivot_textgrid_tiers("fake name") |>
    expect_error("must be used")
})

test_that("pivoting works with multiple tiers", {
  path <- testthat::test_path("test-data/nested-intervals.TextGrid")
  phones <- c("sil", "HH", "AH1", "G", "sp", "D", "AE1", "D", "IY0", "sp", "")
  words <- rep(c("", "hug", "", "daddy", ""), c(1, 3, 1, 4, 2))

  data <- path |>
    read_textgrid()

  p2 <- data |> pivot_textgrid_tiers(c("words", "phones"))

  p2$words |>
    expect_equal(words)

  p2$phones |>
    expect_equal(phones)

  p2 |>
    hasName(c("words_xmin", "words_xmid", "words_xmax")) |>
    all() |>
    expect_true()

  p2 |>
    hasName(c("phones_xmin", "phones_xmid", "phones_xmax")) |>
    all() |>
    expect_true()

})



test_that("we match Praat.exe's parsing behavior", {
  c("+1.0", "000", "3e", "3E", "-2", "0xA", ".5", "+.0") |>
    cpp_parse_praat_numbers() |>
    _$value |>
    expect_equal(c(1, 0, 3, 3, -2, 10, NA_real_, NA_real_))
})