summaryrefslogtreecommitdiff
path: root/R/rsc_cv.R
diff options
context:
space:
mode:
Diffstat (limited to 'R/rsc_cv.R')
-rw-r--r--R/rsc_cv.R226
1 files changed, 182 insertions, 44 deletions
diff --git a/R/rsc_cv.R b/R/rsc_cv.R
index 4153322..660695e 100644
--- a/R/rsc_cv.R
+++ b/R/rsc_cv.R
@@ -1,79 +1,140 @@
-rsc_cv <- function(x, cv.type = "kfold", R = 10, K = 10, threshold = seq(0.05, 0.95,
- by = 0.025), even.correction = FALSE, na.rm = FALSE, ncores = NULL, monitor = TRUE) {
+rsc_cv <- function(x,
+ cv.type = "kfold",
+ R = 10,
+ K = 10,
+ threshold = seq(0.05, 0.95, by = 0.025),
+ even.correction = FALSE,
+ na.rm = FALSE,
+ ncores = NULL,
+ monitor = TRUE) {
+
+ ## ## *****************************************************************************
+ ## ## RSC inputs
+ ## ## *****************************************************************************
+ ## x = X
+ ## cv.type = "random" ## "kfold" "random"
+ ## R = 10 ## replicate (for K-fold) or splits for random
+ ## K = 10 ## folds in kfcv
+ ## threshold = seq(0.025, 0.975, by = 0.025)
+ ## opt = "min" , ## "min" "min1se"
+ ## even.correction = FALSE
+ ## na.rm = TRUE
+ ## ncores = 6
+ ## monitor = TRUE
+ ## ## *****************************************************************************
+
+
+ ## check input data
dat <- .check_input_data_matrix(x = x, y = NULL, na.rm = na.rm)
colnames_original <- colnames(dat)
storage.mode(dat) <- "double"
n <- as.integer(nrow(dat))
p <- as.integer(ncol(dat))
- nc <- as.integer({
- p^2 - p
- }/2)
+
+ ## check cv.type
if ({
cv.type != "random"
} & {
cv.type != "kfold"
}) {
- stop("\"cv.type\" must be either \"random\" (default) or \"kfold\"")
+ stop('"cv.type" must be either "random" (default) or "kfold"')
}
+
+
+ ## check R
if (!is.numeric(R)) {
- stop("\"R\" must be an integer > 1")
- }
- else if (R < 1) {
- stop("\"R\" must be an integer > 1")
+ stop('"R" must be an integer > 1')
+ } else if (R < 1) {
+ stop('"R" must be an integer > 1')
}
+
+
+ ## check K
if (!is.numeric(K)) {
- stop("\"K\" must be an integer > 1")
- }
- else if (R < 1) {
- stop("\"K\" must be an integer > 1")
+ stop('"K" must be an integer > 1')
+ } else if (R < 1) {
+ stop('"K" must be an integer > 1')
}
+
+
+ ## check threshold
if (length(threshold) == 1) {
if (threshold <= 0 | threshold >= 1) {
- stop("\"threshold\" value does not belong to the interval (0,1).")
+ stop('"threshold" value does not belong to the interval (0,1).')
}
- }
- else if (length(threshold) > 1) {
+ } else if (length(threshold) > 1) {
+ ##
if (any(threshold < 0) | any(threshold >= 1)) {
- stop("Some of the \"threshold\" values do not belong to the interval (0,1).")
+ stop('Some of the "threshold" values do not belong to the interval (0,1).')
}
grid.length <- length(threshold)
}
+
+
+
+
+
+ ## set even correction
if (even.correction) {
evencorrection <- 1L
- }
- else {
+ } else {
evencorrection <- 0L
}
+
+
+
+ ## set and check ncores
if (is.null(ncores)) {
DetectedCores <- detectCores()
if (DetectedCores <= 2) {
ncores <- 1
- }
- else {
+ } else {
ncores <- {
DetectedCores - 1
}
}
- }
- else {
+ } else {
ncores <- as.integer(ncores)
if (ncores <= 0) {
- stop("\"ncores\" must be an integer larger or equal to 1.")
+ stop('"ncores" must be an integer larger or equal to 1.')
}
}
+
+
+
+
+
+
+
+
+
+
+ ## compute the RMAD vec form
if (monitor) {
cat("\n")
message("Computing the RMAD matrix")
t0 <- Sys.time()
}
- rmad_vec <- .Fortran("cormadvecdp", matrix = dat, nrow = n, ncol = p, res = numeric(nc),
- ressize = nc, correcteven = evencorrection, PACKAGE = "RSC")$res
+
+ rmad_vec <- .Call(C_cormad_C, dat, n, p, evencorrection, num.threads = 1)
+
if (monitor) {
t1 <- Sys.time()
dt01 <- difftime(t1, t0, units = "auto")
- message("* RMAD computing time:...... ", round(dt01, 2), " [", attributes(dt01)$units,
- "]")
+ message(
+ "* RMAD computing time:...... ", round(dt01, 2),
+ " [", attributes(dt01)$units, "]"
+ )
}
+
+
+
+
+
+
+
+
+
if (cv.type == "random") {
if (monitor) {
cat("\n")
@@ -81,28 +142,55 @@ rsc_cv <- function(x, cv.type = "kfold", R = 10, K = 10, threshold = seq(0.05, 0
t_hat <- round(1.2 * {
{
dt01 * R * 2
- }/ncores
+ } / ncores
}, 2)
message("* predicted end time (worst case):...... ", Sys.time() + t_hat)
}
- n1 <- n - floor(n/log(n))
+
+
+ ## IDX[k,i] = TRUE means dat[i, ] is in train set at the k-th split
+ n1 <- n - floor(n / log(n)) ## train set
IDX <- array(FALSE, dim = c(R, n))
for (r in 1:R) {
IDX[r, ][sample(1:n, size = n1, replace = FALSE)] <- TRUE
}
+
+ ## register parallel backend
registerDoParallel(ncores)
+
+ ## parallel computation of losses over splits
U <- foreach(r = 1:R) %dopar% {
- .cv_loss(idx = IDX[r, ], dat = dat, evencorrection = evencorrection,
- threshold = threshold, grid.length = grid.length, p = p, nc = nc)
+ .cv_loss(
+ idx = IDX[r, ], dat = dat, evencorrection = evencorrection,
+ threshold = threshold, grid.length = grid.length,
+ p = p
+ )
}
+
+ ## stop parallel backend
stopImplicitCluster()
+
+ ## LOSS[split , threshold]
+ ## array with normalized squared Frobenius loss
LOSS <- array(0, dim = c(R, grid.length))
for (r in 1:R) {
LOSS[r, ] <- U[[r]]
}
+
+ ## Estimate average loss with std errors
avg_loss <- apply(LOSS, 2, mean)
- se_loss <- apply(LOSS, 2, sd)/sqrt(R)
+ se_loss <- apply(LOSS, 2, sd) / sqrt(R)
}
+
+
+
+
+
+
+
+
+
+
if (cv.type == "kfold") {
if (monitor) {
cat("\n")
@@ -110,35 +198,59 @@ rsc_cv <- function(x, cv.type = "kfold", R = 10, K = 10, threshold = seq(0.05, 0
t_hat <- round(1.2 * {
{
dt01 * R * K * 2
- }/ncores
+ } / ncores
}, 2)
message("* predicted end time (worst case):...... ", Sys.time() + t_hat)
}
+
+ ## create K deterministic folds
idx_fold <- cut(1:n, breaks = K, labels = FALSE)
+
+ ## IDX :: indexes of all train sets
+ ## IDX[k , i] = TRUE means dat[i, ] is in the train set at some k-th split
+ ## rows {{r-1}*K + 1 }:{r*K} of IDX correspond to the r-th replica
IDX <- array(TRUE, dim = c(R * K, n))
+
+ ## set initial IDX row counter
row_count <- 1L
for (r in 1:R) {
+ ## at each replicate r shuffle the original fold indexes
idx_fold_shuffle <- sample(idx_fold, size = n, replace = FALSE)
+
+ ## for each fold shuffle make up the K-fold
for (k in 1:K) {
IDX[row_count, ][idx_fold_shuffle == k] <- FALSE
row_count <- 1L + row_count
}
}
+
+
+ ## register parallel backend
registerDoParallel(ncores)
+
+ ## parallel computation of losses over splits
U <- foreach(r = 1:{
R * K
}) %dopar% {
- .cv_loss(idx = IDX[r, ], dat = dat, evencorrection = evencorrection,
- threshold = threshold, grid.length = grid.length, p = p, nc = nc)
+ .cv_loss(
+ idx = IDX[r, ], dat = dat, evencorrection = evencorrection,
+ threshold = threshold, grid.length = grid.length,
+ p = p
+ )
}
+
+ ## stop parallel backend
stopImplicitCluster()
+
+
+ ## LOSS[fold , threshold, replica]
if (R == 1) {
LOSS <- array(0, dim = c(K, grid.length))
+ ## names ??
for (k in 1:K) {
LOSS[k, ] <- U[[k]]
}
- }
- else {
+ } else {
LOSS <- array(0, dim = c(K, grid.length, R))
dimnames(LOSS)[[3]] <- paste0("r", 1:R)
dimnames(LOSS)[[1]] <- paste0("k", 1:K)
@@ -150,21 +262,33 @@ rsc_cv <- function(x, cv.type = "kfold", R = 10, K = 10, threshold = seq(0.05, 0
}
}
}
+
+
+ ## compute average losses and standard errors
avg_loss_r <- sd_loss_r <- matrix(0, nrow = R, ncol = grid.length)
for (r in 1:R) {
avg_loss_r[r, ] <- apply(LOSS[, , r], 2, mean)
- sd_loss_r[r, ] <- apply(LOSS[, , r], 2, sd)/sqrt(K)
+ sd_loss_r[r, ] <- apply(LOSS[, , r], 2, sd) / sqrt(K)
}
avg_loss <- apply(avg_loss_r, 2, mean)
se_loss <- apply(sd_loss_r, 2, mean)
+
+
+
if (monitor) {
t2 <- Sys.time()
dt02 <- difftime(t2, t0, units = "auto")
}
- }
+ } ## END if(cv.type == "kfold"){
+
+
+
if (monitor) {
message("* finished on:.......................... ", Sys.time())
}
+
+
+ ## Organize cross-validation results
tstar <- which.min(avg_loss)
flags <- rep("", grid.length)
a <- avg_loss[tstar] - se_loss[tstar]
@@ -175,9 +299,23 @@ rsc_cv <- function(x, cv.type = "kfold", R = 10, K = 10, threshold = seq(0.05, 0
avg_loss <= b
}] <- "*"
flags[tstar] <- "minimum"
- res <- data.frame(Threshold = threshold, Average = avg_loss, SE = se_loss, Flag = flags)
- ans <- list(rmadvec = rmad_vec, varnames = colnames_original, loss = res, minimum = threshold[tstar],
- minimum1se = max(threshold[avg_loss >= a & avg_loss <= b]))
+ res <- data.frame(
+ Threshold = threshold,
+ Average = avg_loss,
+ SE = se_loss,
+ Flag = flags
+ )
+
+ ## output list
+ ans <- list(
+ rmadvec = rmad_vec,
+ varnames = colnames_original,
+ loss = res,
+ minimum = threshold[tstar],
+ minimum1se = max(threshold[avg_loss >= a & avg_loss <= b])
+ )
+
+
class(ans) <- "rsc_cv"
return(ans)
}