data-raw/cereal/cereal_usedatadoc.R

In friendly/candisc: Visualizing Generalized Canonical Discriminant and Canonical Correlation Analysis

#' @name cereal
#' @aliases cereal
#' @docType data
#' @title
#' %%   ~~ data name/kind ... ~~
#'
#' @description
#' %%  ~~ A concise (1-5 lines) description of the dataset. ~~
#'
#' @usage data("cereal")
#' @format
#'  A data frame with 77 observations on the following 16 variables.
#'  \describe{
#'    \item{\code{name}}{name = cereal name , a character vector}
#'    \item{\code{mfr}}{mfr = manufacturer (A  G  K  N  P  Q  R) , a character vector}
#'    \item{\code{type}}{type = type (cold/hot)  , a character vector}
#'    \item{\code{calories}}{calories = calories (number) , a numeric vector}
#'    \item{\code{protein}}{protein = protein(g) , a numeric vector}
#'    \item{\code{fat}}{fat = fat(g) , a numeric vector}
#'    \item{\code{sodium}}{sodium = sodium(mg) , a numeric vector}
#'    \item{\code{fiber}}{fiber = dietary fiber(g) , a numeric vector}
#'    \item{\code{carbo}}{carbo = complex carbohydrates(g) , a numeric vector}
#'    \item{\code{sugars}}{sugars = sugars(g) , a numeric vector}
#'    \item{\code{potass}}{potass = potassium(mg)  , a numeric vector}
#'    \item{\code{vitamins}}{vitamins = vitamins & minerals (0, 25, or 100, respectively indicating 'none added'; 'enriched, often to 25% FDA recommended'; '100% of FDA recommended') , a numeric vector}
#'    \item{\code{shelf}}{shelf = display shelf (1, 2, or 3, counting from the floor) , a numeric vector}
#'    \item{\code{weight}}{weight = weight (in ounces) of one serving (serving size) , a numeric vector}
#'    \item{\code{cups}}{cups = cups per serving , a numeric vector}
#'    \item{\code{rating}}{rating = health rating of the cereal (unknown calculation method) , a numeric vector}
#'  }
#'
#' @details 
#' %%  ~~ If necessary, more details than the __description__ above ~~
#' @source 
#' %%  ~~ reference to a publication or URL from which the data were obtained ~~
#' @references
#' %%  ~~ possibly secondary sources and usages ~~
#'
#' @concept %% non-keyword concepts, one per line
#' @examples
#' data(cereal)
#' ## maybe str(cereal) ; plot(cereal) ...
#'
#' @keywords datasets
NULL