R/crab.R

In julianfaraway/brinla: Bayesian Regression with INLA

#' crab
#'
#'
#' The data set for a study of nesting horseshoe crabs.
#'
#' @docType data
#'
#' @usage data(crab)
#'
#' @format A data frame with 5 columns and 173 rows. The columns are:
#' \itemize{
#' \item{COLOR: }{Crab’s color; 1 = light medium; 2 = medium; 3 = dark medium; 4 = dark.}
#' \item{SPINE: }{Crab’s spine condition; 1 = both good; 2 = one worn or broken; 3 = both worn or broken.}
#' \item{WEIGHT: }{Crab’s weight in kilogram.}
#' \item{WIDTH: }{Crab’s carapace width in centimeter.}
#' \item{SATELLITES: }{The number of satellites for a female crab.}
#' }
#' @details In this study, each female horseshoe crab in the study had a male crab attached to her in her nest. The study investigated factors that affect whether the female crab had any other males, called satellites, residing near her.     
#'
#' @keywords datasets
#'
#' @references Brockmann, H. J. (1996). Satellite male groups in horseshoe crabs, limulus polyphe- mus. Ethology 102(1), 1–21.
#' @references Agresti, A. (2012). Categorical Data Analysis (3rd ed.). New York: Wiley.
#'
#'
#' @examples
#' data(crab)
"crab"