R/diamonds_simple.R

#' @name diamonds_simple
#' @title Simplified diamonds data
#' @description This data set contains 320 observations from the well-known
#' \code{diamonds} data set in the \code{ggplot2} package. 40 observations
#' were randomly selected from each of the 8 \code{clarity} levels.
#' Furthermore, a factor variable, \code{inclusions}, has been added that
#' indicates whether each observation has a noticeable inclusion at 10x
#' magnification based on
#' the \code{clarity} variable.
#'
#' @docType data
#' @usage data(diamonds_simple)
#'
#' @format A data frame with 360 rows and 11 variables
#' \describe{
#'   \item{price}{price in US dollars ($326--$18,823)}
#'   \item{carat}{weight of the diamond (0.2--5.01)}
#'   \item{cut}{quality of the cut (Fair, Good, Very Good, Premium, Ideal)}
#'   \item{color}{diamond colour, from D (best) to J (worst)}
#'   \item{clarity}{a measurement of how clear the diamond is (I1 (worst), SI2,
#'     SI1, VS2, VS1, VVS2, VVS1, IF (best))}
#'   \item{x}{length in mm (0--10.74)}
#'   \item{y}{width in mm (0--58.9)}
#'   \item{z}{depth in mm (0--31.8)}
#'   \item{depth}{total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)}
#'   \item{table}{width of top of diamond relative to widest point (43--95)}
#'   \item{inclusions}{minor or noticeable inclusions. \code{"noticeable"}
#'   if \code{clarity} is I1, S1, or S2. Otherwise, \code{"minor"}.}
#' }
#' @source \code{ggplot2} package via <http://www.diamondse.info/>
NULL
jfrench/bayesutils documentation built on April 10, 2023, 6:28 p.m.