R/is_q2metadata.R

In jbisanz/qiime2R: qiime2R

#' checks if metadata is in qiime2 (.tsv)
#'
#' Checks to see if a file is in qiime2 metadata format, ie contains #q2:types line dictating the type of variable (categorical/numeric)
#'
#' @param file path to the input file, ex: file="~/data/moving_pictures/table.qza"

#' @return TRUE/FALSE
#'
#' @examples \dontrun{metadata<-is_q2metadata("q2metadata.tsv")}
#' @export
#'
#'

is_q2metadata <- function(file){

  if (!file.exists(file)){stop("Input metadata file (",file,") not found. Please check path and/or use list.files() to see files in current working directory.")}

  suppressWarnings(
  if(grepl("^#q2:types", readLines(file)[2])){return(TRUE)}else{return(FALSE)}
  )
}