R/products.R

In completejourney: Retail Shopping Data

#' @title Product metadata.
#'
#' @description 
#' Product metadata for all products purchased by households participating in
#' the Customer Journey study.
#'
#' @source 84.51°, Customer Journey study, \url{http://www.8451.com/area51/}
#' @format A data frame with 92,331 rows and 7 variables
#' \itemize{
#' \item product_id: Uniquely identifies each product
#' \item manufacturer_id: Uniquely identifies each manufacturer
#' \item department: Groups similar products together
#' \item brand: Indicates Private or National label brand
#' \item product_category: Groups similar products together at lower level
#' \item product_type: Groups similar products together at lowest level
#' \item package_size: Indicates package size (not available for all products)
#' }
#' 
#' @docType data
#' @return \item{products}{a tibble}
#' @keywords datasets
#' 
#' @examples
#' \donttest{
#' # full data set
#' products
#'
#' # Transaction line items that don't have product metadata
#' require("dplyr")
#' transactions_sample %>%
#'   anti_join(products, "product_id")
#' }
#' @importFrom tibble tibble
"products"