R/read_in.R

In nmfs-fish-tools/data_dictionary: Collaborative tool to improve consistency in terminology and develop a framework of tools for fisheries science.

#' Function to read in a txt and make it a data frame
#'
#' @param filename name of the txt file to convert to JSON
#' @export
read_in <- function(filename = "inst/extdata/top20.txt") {
  input_data <- readLines(filename, encoding = "UTF-8")
  names_index <- seq(from = 1, to = 140, by = 7)
  titles <- input_data[names_index]
  namedef <- unlist(strsplit(titles, split = ": "))
  namedef_df <- as.data.frame(matrix(namedef, ncol = 2, byrow = TRUE))
  names(namedef_df) <- c("name", "description")
  string_names <- c(
    "Examples", "ICES code type", "Units",
    "Rationale", "Alternatives", "Range of possible values"
  )
  for (i in seq_len(length(string_names))) {
    ind <- grep(input_data,
      pattern = paste0(string_names[i], ":"), ignore.case = T
    )
    strings <- gsub(
      pattern = paste0(string_names[i], ":"),
      replacement = "", x = input_data[ind], ignore.case = T
    )
    namedef_df[[string_names[i]]] <- strings
  }

  return(namedef_df)
}