R/example_data.R

#' Palmer Penguin Dataset
#'
#' A cleaned version of the Palmer Penguins dataset from the package
#' `palmerpenguins` (i.e. all missing removed). This serves primarily as an
#' example dataset for plotting examples.
#'
#' @format A tibble with 333 rows and 8 columns
#' \describe{
#'   \item{species}{Penguin's species}
#'   \item{island}{Penguin's island}
#'   \item{bill_length_mm}{Bill length in mm}
#'   \item{bill_depth_mm}{Bill depth in mm}
#'   \item{flipper_length_mm}{Flipper length in mm}
#'   \item{body_mass_g}{Weight in g}
#'   \item{sex}{Sex}
#'   \item{year}{Year of observation}
#' }
#'
#' @source \url{https://github.com/allisonhorst/palmerpenguins}
"palmer_penguins"
benediktclaus/benelib documentation built on Feb. 1, 2024, 1:39 a.m.