R/transform.R

Defines functions finitise positivise replaceNA twopq mlog10p safe valuesof Surv2 landmark

Documented in finitise landmark mlog10p positivise replaceNA safe Surv2 twopq valuesof

## convenience function, convert +-Inf to NA
#' @export
finitise <- function(x) return(ifelse(is.finite(x), x, NA))

## convenience function, convert <[=]0 to NA
#' @export
positivise <- function(x, strict = FALSE) {
  if (strict) {
    return(ifelse(x > 0, x, NA))
  } else {
    return(ifelse(x >= 0, x, NA))
  }
}

## convenience function to replace NA with something else
#' @export
replaceNA <- function(x, replacement = NA) {
  x[is.na(x)] <- replacement
  return(x)
}

## convenience function 
#' @export
twopq <- function(p) return(2*p*(1 - p))

## convenience function for computing -log10(p) when p is very small
## [such that -log10(pnorm(-abs(beta)/se)*2) fails because
## pnorm() returns zero to machine precision]
#' @export
mlog10p <- function(beta, se) {
  if (missing(se)) se <- rep(1, length(beta))
  stopifnot(identical(length(beta), length(se)))
  return(-(pnorm(-abs(beta)/se, log.p = TRUE) + log(2))/log(10))
}


##
## zise() performs normal quantile transformation
##
#' @export
zise <- function (x, only, by) {
  if (length(x) < 1) return(x)
  if (missing(only)) {
    only <- which(!is.na(x))
  } else {
    stopifnot(length(only) == length(x))
    only <- which(only & !is.na(x))
  }
  zx <- rep(NA, length(x))
  if (length(only) >= 1) {
    if (missing(by)) {
      zx[only] <- qnorm((rank(x[only]) - 0.5)/length(only))
    } else {
      stopifnot(length(by) == length(x))
      by <- factor(by)
      for (by1 in levels(by)) {
        onlyby <- intersect(only, which(by == by1))
        if (length(onlyby) >= 1) {
          zx[onlyby] <- qnorm((rank(x[onlyby]) - 0.5)/length(onlyby))
        }
      }
    }
  }
  return(zx)
}

zise.old <- function (x) {
  return(qnorm((rank(x, na.last = "keep") - 0.5) / sum(!is.na(x))))
}

#' @export
ile <- function (x, levels.out) {
  x <- as.double(x)
  ## if no levels.out specified, use three levels named 1,2,3
  if (missing(levels.out)) levels.out <- 1:3
  ## if levels.out is an integer of length 1, assume numbered levels
  if (identical(length(levels.out), 1L)) levels.out <- 1:as.integer(levels.out)
  n <- length(levels.out)
  xd <- ceiling(n * (rank(x, na.last = "keep") - 0.5)/sum(!is.na(x)))
  return(factor(levels.out[xd], levels.out))
}



##
## usage: safe(min, x), etc.
##
#' @export
safe <- function(FUN, x, ...) {
  stopifnot(is.function(FUN))
  x <- as.vector(x)
  x <- x[!is.na(x)]
  if (length(x) == 0) return(NA)
  return(FUN(x, ...))
}

#' @export
valuesof <- function(x, sep = ",", na.convert = NA) {
  x <- as.vector(x)
  x[is.na(x)] <- na.convert
  x <- x[!is.na(x)]
  if (length(x) == 0) return(NA)
  paste(as.character(unique(x)), collapse = sep)
}

#' @export
Surv2 <- function(tevent, tcensor) {
  stopifnot(identical(length(tevent), length(tcensor)))
  event <- !is.na(tevent) & tevent <= tcensor
  return(Surv(time = ifelse(event, tevent, tcensor),
              event = event,
              type = 'right'))
}

#' @export
landmark <- function(s, tstart) {
  stopifnot(identical(class(s), "Surv"))
  if (identical(length(tstart), 1L)) {
    tstart <- rep(tstart, nrow(s))
  }
  stopifnot(identical(length(tstart), nrow(s)))
  inc <- s[ , "time"] >= tstart
  return(Surv(ifelse(inc, s[ , "time"] - tstart, NA), ifelse(inc, s[ , "status"], NA)))
}
tobyjohnson/gtx documentation built on Aug. 30, 2019, 8:07 p.m.