R/checkREADMEColumnNames.R

In ondri-nibs/standards_app: ONDRI Standards ShinyApp

# checkREADMEColumnNames.R
#
# Purpose: Check to ensure that all column names in the README file are valid and at the 
# right position.
#
# Author: Jedid Ahn (jahn@research.baycrest.org)
#
# Date: 2019-07-09
#
# ==========================================================================================

checkREADMEColumnNames <- function(readmeDF, dirName){
  flaggedMsgs <- character()
  columnNames <- colnames(readmeDF)
    
  # 1) Look for valid column names.
  if (columnNames[1] != "FILE"){
    line <- paste(tags$span(class = "bold-category", 
                            "README Column Names: Directory", dirName),
                  "- FILE column is missing and/or is not the 1st column.")
    flaggedMsgs <- c(flaggedMsgs, line)
  }
  
  if (columnNames[2] != "DESCRIPTION"){
    line <- paste(tags$span(class = "bold-category", 
                            "README Column Names: Directory", dirName),
                  "- DESCRIPTION column is missing and/or is not the 2nd column.")
    flaggedMsgs <- c(flaggedMsgs, line)
  }

  
  # 2) Check for any invalid column names.
  if (any(columnNames != "FILE" & columnNames != "DESCRIPTION")){
    colNums <- which(columnNames != "FILE" & columnNames != "DESCRIPTION")
    line <- paste(tags$span(class = "bold-category", 
                            "README Column Names: Directory", dirName),
                  "- The following column #'s have an invalid column name:",
                  tags$span(class = "colour-category", paste(colNums, collapse = ", ")))
    flaggedMsgs <- c(flaggedMsgs, line)
  }
  
  if (any(columnNames == "NO_TITLE")){
    colNums <- which(columnNames == "NO_TITLE")
    line <- paste(tags$span(class = "bold-category", 
                            "README Column Names: Directory", dirName),
                  "- The following column #'s have no column name:",
                  tags$span(class = "colour-category", paste(colNums, collapse = ", ")))
    flaggedMsgs <- c(flaggedMsgs, line)
  }
  
  
  # 3) Check column name syntax.
  flaggedMsgs <- c(flaggedMsgs, checkColumnNameSyntax(readmeDF, dirName))
  
  
  # 4) Check for any column name duplicates.
  flaggedMsgs <- c(flaggedMsgs, checkForColumnNameDuplicates(readmeDF, dirName))
  
  
  return (flaggedMsgs)
}

# [END]