R/validator.r

In SCCWRP/algaeMetrics: Algae metrics and IBIs

#' Algae data validation
#' 
#' Checks that required columns are present in algae data frame
#' 
#' @export
#' @examples
#' data(algaeSamples)
#' validator(algaeSamples)


validator <- function(data){
  required.fields <- c("StationCode","SampleDate","Replicate", #Helpful but not really required
                       "SampleTypeCode", #Required, can never be blank
                       "FinalID","BAResult","Result", #Required. Blanks OK
                       "ActualOrganismCount" #Required for QC, but allow calculation if missing or blank
  )
  coltest <- required.fields %in% names(data)
  if(!all(coltest))
    stop(do.call(paste, as.list(c("Missing the following columns:", required.fields[!coltest]))))
  else{
    if(!is.null(data$SampleID))
      required.fields <- c("SampleID", required.fields)
    data[, required.fields] 
  } 
}