R/funLogOdds.R

In ConNEcT: Contingency Measure-Based Networks for Binary Time Series

#' Calculate the log odds ratio between two vectors
#'
#' @param vec1 Vector of binary time series (no missing values)
#' @param vec2 Vector of binary time series (equal length as vec1, no missing values)
#'
#' @return list with two elements
#' @return \code{value} of the log odds ratio and
#' @return \code{funName} name of the function
#' @export
#'
#' @examples data1 <- rep(c(1,0,1,1),25)
#'         data2 <- ifelse(rnorm(100,0,1)<0.7,0,1)
#'         funLogOdds(data1,data2)

funLogOdds<-function(vec1,vec2){

  bothone<-sum((vec1+vec2)==2)
  bothzero<-sum((vec1+vec2)==0)
  firstone<-sum((vec1==1&vec2==0))
  secondone<-sum((vec1==0&vec2==1))

  OddsRatio<-bothone*bothzero/(firstone*secondone)
  value<-log(OddsRatio)
  funName <- 'Log Odds Ratio'
  result <- list(value,funName)
  names(result) <- c("value","funName")
  return(result)
}