nutterb / argumentcheck Goto Github PK

JSD <- function(data, gp){
  ck <- ArgumentCheck::newArgCheck()
  ck <- ArgumentCheck::addError(is.data.frame(data), "'data' must be a data frame", ck)
  ck <- ArgumentCheck::addError(length(intersect(class(gp),c("character","factor")))>0,
                                "'gp' must be either the name of a factor variable in 'data' or a factor",
                                ck)
  finishArgCheck(ck)
  n <- nrow(data)

  ##########################################################
  # Note that I had to evaluate 'length(gp)>1' twice here
  ##########################################################
  if(is.character(gp)){
    ck <- ArgumentCheck::addWarning(length(gp)>1,
                                    "'gp' is a character vector of length >1. Using only the first element",
                                    ck)
    if(length(gp)>1) gp <- gp[1]
  }
  else if(is.factor(gp)){
    ck <- ArgumentCheck::addError(length(gp) == n,
                                  "factor 'gp' must have same length as number of rows in 'data'",
                                  ck)
  }
  ##########################################################
  # Note that I had to evaluate 'TRUE' here. 
  # Maybe making 'expr' an optional parameter would be good.
  # Or...what about setting 'expr=TRUE" by default?
  ##########################################################
  else Check <- ArgumentCheck::addError(TRUE,
                                        msg = "'gp' must be a numeric array",
                                        argcheck = Check)

}