R/data.R

#' Set of example recipes
#'
#' A dataset containing 26 example recipes originating from recipe boxes ordered
#' from [Riverford](https://www.riverford.co.uk). Riverford are a wonderful UK
#' company producing sustainable, delicious, locally-sourced food - check them
#' out!
#'
#' @format A `tibble::tibble()` with 26 rows and 4 columns:
#' \describe{
#'   \item{title}{`character()` recipe name.}
#'   \item{title_tidy}{`character()` recipe name in computer-friendly format.}
#'   \item{ingredients}{
#'     `character()` quantity and type of ingredient, separated by a ";".
#'     }
#'   \item{instructions}{
#'     `character()` instructions for cooking for each recipe.
#'   }
#' }
#'
#' @source generated using `autorecipes/data-raw/recipes_example.R`
"recipes_example"

#' An example recipe book
#'
#' A `RecipeBook-class` object that has been created using
#' `autorecipes::create_recipebook()` containing 26 example recipes. The recipes
#' originate from recipe boxes ordered from
#' [Riverford](https://www.riverford.co.uk). Riverford are a wonderful UK
#' company producing sustainable, delicious, locally-sourced food - check them
#' out!
#'
#' @format A `tibble::tibble()` with 26 rows and 2 columns:
#' \describe{
#'   \item{names}{`character()` recipe name.}
#'   \item{ingredients}{
#'     `character()` name, quantity and type of ingredient, stored as a `list()`
#'         of `Ingredients-class` objects.
#'     }
#' }
#'
#' @source generated using `autorecipes/data-raw/recipebook_example.R`
"recipebook_example"
dzhang32/autorecipes documentation built on April 15, 2022, 3:29 a.m.