R/example.data.highdim.R

In SurrogateRank: Rank-Based Test to Evaluate a Surrogate Marker

#' High‑dimensional surrogate candidate example dataset
#'
#' A simulated high‑dimensional dataset for demonstrating the RISE methodology
#' implemented in \pkg{SurrogateRank}. The data contains primary response and
#' 1000 surrogate candidates from 25 treated individuals and 25 untreated individuals,
#' where 10% of the surrogate candidates are "valid".
#'
#' @format A list containing :
#' \describe{
#'   \item{y1}{primary response in treated}
#'   \item{y0}{primary response in untreated}
#'   \item{s1}{1000 surrogate candidates in treated}
#'   \item{s0}{1000 surrogate candidates in untreated}
#'   \item{hyp}{for each surrogate, \code{null false} if the surrogate is valid}
#' }
#'
#' @usage data("example.data.highdim", package = "SurrogateRank")
#'
#' @examples
#' data("example.data.highdim", package = "SurrogateRank")
#' head(example.data.highdim)
#'
#' @source Simulated for package examples.
#' @docType data
#' @keywords datasets
"example.data.highdim"