R/write.TextGrid.R

In jpellman/textgridR: textgridR

#' @name write.TextGrid
#' @title Export a TextGrid
#' @description Exports a TextGrid file to a specified file path.
#' 
#' @param x A TextGrid object.
#' @param file A file connection or a character vector containing the path to where the file should be saved.
#' 
#' @return A logical indicating whether or not the write was successful.
#' @author John Pellman

write.TextGrid <- function(x, file){
  # Okay, here's my 3 AM insomniac pseudocode for this:
  
  # Ensure that x is actually a TextGrid; throw an error otherwise (typecasting would be problematic here).
  
  # Set up a file connection.
  
  # Make an array of strings using the c() function (a character vector in R terminology), 
  # with each slot x representing line x of the TextGrid file.
  
  # Perhaps this should check to make sure that tiers still exist.
  # Sets up head:
  tg <- c('File type = "ooTextFile"', 'Object class = "TextGrid"', '', 
          paste0('xmin = ', attributes(x)$xmin), paste0('xmax = ', attributes(x)$xmax),
          'tiers? <exists>', paste0('size = ', attributes(x)$size), 'item []: ')
  # There's probably an apply-based way of doing this, but we'll stick to for loops for now.
  for (i in 1:length(x)){
    tg <- c(tg, paste0('    ', 'item [',i,']:'))
    if (class(x[[i]])=="TextGridIntervalTier"){
      tg <- c(tg, '        class = "IntervalTier"')
    }
    tg <- c(tg, paste0('        name = "', attributes(x[[i]])$name,'"'), 
            paste0('        xmin = ', attributes(x[[i]])$xmin), paste0('        xmax = ', attributes(x[[i]])$xmax), 
            paste0('        intervals: size = ', length(x[[i]])))
    for (j in 1:length(x[[i]])){
      tg <- c(tg, paste0('        intervals [',j,']:'), paste0('            xmin = ', grid[[i]][[j]]$xmin),
              paste0('            xmax = ', grid[[i]][[j]]$xmax), paste0('            text = "', grid[[i]][[j]]$text,'"'))
    }
  }
  # The above is quite a bit more complicated than it seems right now, and requires
  # a well-rested brain to fully deliberate what needs to be done (i.e., I need to review
  # the formatting of a TextGrid file before I can proceed).
  
  # Pipe that character vector out to file using writeLines().
  writeLines(tg, file)
  # Reminder: write is not an S3 generic.
  
  return(TRUE)
}