R/utilities.R

In spcopula: Copula Driven Analysis - Multivariate, Spatial, Spatio-Temporal

## utilities


# ranks are automatically removed and NAs are by default randomly distributed
rankTransform <- function(u,v=NULL, na.last=TRUE, ties.method="average") {
  if(!(is.matrix(u) | is.data.frame(u))) {
    if (is.null(v))
      stop("u must either be a matrix with at least 2 columns or u and v must be given.")
    else
      u <- cbind(u,v)
  }

  res <- apply(u,2,function(x) rank(x,na.last,ties.method)/(sum(!is.na(x))+1))
  if(is.data.frame(u))
    return(as.data.frame(res))
  return(res)
}

##
dependencePlot <- function(var=NULL, smpl, bandwidth=0.075, 
                           main="Strength of dependence", 
                           transformation=function (x) x, margin=NULL, ...) {
  if(is.null(var)) {
    if (ncol(smpl)>2) {
      smpl <- smpl[,1:2]
    }
  } else {
    smpl <- smpl[,var]
  }
  
  if(is.null(margin))
    smoothScatter(smpl,bandwidth=bandwidth, asp=1, xlim=c(0,1), ylim=c(0,1), 
                  nrpoints=0, main=main,
                  transformation=transformation, ...)
  else
    smoothScatter(margin(smpl), bandwidth=bandwidth, asp=1, 
                  nrpoints=0, main=main, ...)
}

##
unitScatter <- function(var=NULL, smpl, ...) {
  
  if(is.null(var)) {
    if (ncol(smpl)>2) {
      smpl <- smpl[,1:2]
    }
  } else {
    smpl <- smpl[,var]
  }

  for(variable in var){
    if( min(smpl[,variable])<0 | max(smpl[,variable])>1) {
      smpl[,variable] <- rank(smpl[,variable])/(length(smpl[,variable])+1)
      warning("The variable ",variable," seems to exceed [0,1] and has been transformed using the rank order transformation.")
    }
  }

  plot(smpl, asp=1, xlim=c(0,1), ylim=c(0,1), ...)
}

univScatter <- function(formula=NULL, smpl) {
  .Deprecated("unitScatter")
  unitScatter(formula, smpl)
}