R/completeFun.r

In Beothuk/bio.utilities: Package that interacts with bio providing base-level generic routines to make your life easier.

#' @export
#' @title completeFun
#' @description This function removes rows where specific columns have NA, and is a function to return complete rows.
#' @param \code{data} = the matrix/data.frame to be evaluated
#' @param \code{desiredCols} = identifier for the column that must have values
#' @return \code{result} =  matrix/data.frame without rows that had \code{NA} in the \code{desiredCols}
#' @note The name is deceptive - MMM did not find it to be fun at all.
#' @author  Adam Cook, \email{Adam.Cook@@dfo-mpo.gc.ca}
#' @examples
#' A = matrix(c(2, NA, 3, 1, 5, 7), nrow=2, ncol=3, byrow = TRUE)
#' A
#' [,1] [,2] [,3]
#' [1,]    2   NA    3
#' [2,]    1    5    7
#' completeFun(A, 2)
#' [1] 1 5 7
#' @export
completeFun <- function(data, desiredCols) {
  completeVec <- complete.cases(data[, desiredCols])
  return(data[completeVec, ])
}