-## Lines with @ are roxygen2 tags
-#' Change character vectors to a common format
-#' @param names_in Character vector
-#' @param word_delim Character defining the word delimiter for the output character
-#' vector, either " " (space), ".", "-", or "_"
-#' @return character vector of same dimensions as input vector, but with all
-#' elements updated to the new format
-#' @details This function somewhat crudely attempts to force matches in line
-#' names. It does this by converting everything to uppercase, and replacing
-#' all common word delimiters (space, period, underscore, dash) with the selected one.
-#' Note that of the three, only underscores or periods will form syntactically-
-#' valid R variable names (override by reading in tables with check.names = FALSE).
-#' However, underscores can cause problems with reading
-#' VCFs in PLINK, as they will by default be interpreted as delimiters for
-#' family and individual IDs
-#' @suggests stringdist, plyr
-format_char_vec <- function(names_in, word_delim = "-") {
- ## Check for appropriate word delimiter selection
- if(!word_delim %in% c(" ", "-", "_", ".")) {
- stop('Please select one of the following for the output word delimiter:
- " " (space), ".", "-", "_"')
- ## Convert everything to uppercase
- names_out <- toupper(names_in)
- ## Remove leading/trailing whitespace
- names_out <- trimws(names_out, which = "both")
- ## Substitute the word delimiters - doesn't seem to be any very good way to
- ## do this in one fell swoop
- names_out <- gsub(" ", word_delim, names_out)
- names_out <- gsub("-", word_delim, names_out)
- names_out <- gsub("\\.", word_delim, names_out)
- names_out <- gsub("_", word_delim, names_out)
