R/binary-data.R

In braunm/sparseHessianFD: Numerical Estimation of Sparse Hessians

#' @name binary-data
#' @aliases binary_small binary_large binary_super
#' @title Sample simulated data for binary choice example in vignette
#' @description Sample datasets for vignette
#' @details The package provides four sample datasets for the hierarchical binary choice model described in the vignette. These datasets are:
#' \describe{
#' \item{binary}{\eqn{N=50}, \eqn{k=3}}
#' \item{binary_small}{\eqn{N=20}, \eqn{k=2}}
#' \item{binary_large}{\eqn{N=800}, \eqn{k=3}}
#' \item{binary_super}{\eqn{N=1200}, \eqn{k=3}}
#' }
#' \eqn{N} is the number of heterogeneous units.
#' \eqn{k} is the number of covariates.
#'
#' The datasets were generated using the code in data-raw/binary_sim.R.
#' @docType data
NULL

#' @name binary_small-data
#' @docType data
#' @rdname binary-data
NULL

#' @name binary_large-data
#' @docType data
#' @rdname binary-data
NULL

#' @name binary_super-data
#' @docType data
#' @rdname binary-data
NULL