R/data.R

#' Example Data Frame for rtichoke package
#'
#' An example data frame that contains estimated probabilities and binary
#' outcomes, used as an input for rtichoke functions.
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \describe{
#'   \item{estimated_probabilities}{estimated probabilities from some model}
#'   \item{bad_model}{estimated probabilities from some bad model}
#'   \item{random_guess}{random guesses generated from unifrom distribution}
#'   \item{outcome}{binary outcome}
#'   \item{type_of_set}{the type of the set that the observation belongs to}
#'   ...
#' }
"example_dat"


#' Example Performance Data
#'
#' An example Performance Data that contains one model
#'
#' @format A data frame with 101 rows and 14 variables:
"one_pop_one_model_as_a_vector"


#' Example Performance Data
#'
#' An example Performance Data that contains one model
#'
#' @format A data frame with 101 rows and 14 variables:
"one_pop_one_model_as_a_vector_enforced_percentiles_symmetry"


#' Example Performance Data
#'
#' An example Performance Data that contains one model
#'
#' @format A data frame with 101 rows and 15 variables:
"one_pop_one_model_as_a_list"


#' Example Performance Data
#'
#' An example Performance Data that contains one model
#'
#' @format A data frame with 101 rows and 15 variables:
"one_pop_one_model_as_a_list_enforced_percentiles_symmetry"

#' Example Performance Data
#'
#' An example Performance Data that contains three models
#'
#' @format A data frame with 303 rows and 15 variables:
"one_pop_three_models"


#' Example Performance Data
#'
#' An example Performance Data that contains three models
#'
#' @format A data frame with 303 rows and 15 variables:
"one_pop_three_models_enforced_percentiles_symmetry"


#' Example Performance Data
#'
#' An example Performance Data that contains test and train sets
#'
#' @format A data frame with 202 rows and 15 variables:
"train_and_test_sets"


#' Example Performance Data
#'
#' An example Performance Data that contains test and train sets
#'
#' @format A data frame with 202 rows and 15 variables:
"train_and_test_sets_enforced_percentiles_symmetry"


#' Example Performance Data
#'
#' An example Performance Data that contains multiple models
#'
#' @format A data frame with 202 rows and 15 variables:
"multiple_models"

#' Example Performance Data
#'
#' An example Performance Data that contains multiple models
#' stratified by ppcr
#'
#' @format A data frame with 202 rows and 15 variables:
"multiple_models_by_ppcr"


#' Example Performance Data
#'
#' An example Performance Data that contains multiple populations
#'
#' @format A data frame with 202 rows and 15 variables:
"multiple_populations"

#' Example Performance Data
#'
#' An example Performance Data that contains multiple populations
#' stratified by ppcr
#'
#' @format A data frame with 202 rows and 15 variables:
"multiple_populations_by_ppcr"



#' Example Performance Data
#'
#' An example Performance Data that contains one model
#'
#' @format A data frame with 101 rows and 14 variables:
"one_pop_one_model"

#' Example Performance Data
#'
#' An example Performance Data that contains one model stratified by ppcr
#'
#' @format A data frame with 101 rows and 14 variables:
"one_pop_one_model_by_ppcr"
uriahf/rtichoke documentation built on Nov. 22, 2023, 1:30 a.m.