pokedex: Data set for pokemon

#' @title Pokedex of all the information from veekun pokedex
#'
#' @description Veekuns pokedex data as a list of tables.
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \describe{
#'   \item{abilities}{what the thing is}
#'   \item{ability_changelog_prose}{what the thing is}
#'   \item{ability_changelog}{what the thing is}
#'   \item{ability_flavor_text}{what the thing is}
#'   \item{ability_names}{what the thing is}
#'   \item{ability_prose}{what the thing is}
#'   \item{berries}{what the thing is}
#'   \item{berry_firmness_names}{what the thing is}
#'   \item{berry_firmness}{what the thing is}
#'   \item{berry_flavors}{what the thing is}
#'   \item{characteristic_text}{what the thing is}
#'   \item{characteristics}{what the thing is}
#'   \item{contest_combos}{what the thing is}
#'   \item{contest_effect_prose}{what the thing is}
#'   \item{contest_effects}{what the thing is}
#'   \item{contest_type_names}{what the thing is}
#'   \item{contest_types}{what the thing is}
#'   \item{egg_group_prose}{what the thing is}
#'   \item{egg_groups}{what the thing is}
#'   \item{encounter_condition_prose}{what the thing is}
#'   \item{encounter_condition_value_map}{what the thing is}
#'   \item{encounter_condition_value_prose}{what the thing is}
#'   \item{encounter_condition_values}{what the thing is}
#'   \item{encounter_conditions}{what the thing is}
#'   \item{encounter_method_prose}{what the thing is}
#'   \item{encounter_methods}{what the thing is}
#'   \item{encounter_slots}{what the thing is}
#'   \item{encounters}{what the thing is}
#'   \item{evolution_chains}{what the thing is}
#'   \item{evolution_trigger_prose}{what the thing is}
#'   \item{evolution_triggers}{what the thing is}
#'   \item{experience}{what the thing is}
#'   \item{genders}{what the thing is}
#'   \item{generation_names}{what the thing is}
#'   \item{generations}{what the thing is}
#'   \item{growth_rate_prose}{what the thing is}
#'   \item{growth_rates}{what the thing is}
#'   \item{item_categories}{what the thing is}
#'   \item{item_category_prose}{what the thing is}
#'   \item{item_flag_map}{what the thing is}
#'   \item{item_flag_prose}{what the thing is}
#'   \item{item_flags}{what the thing is}
#'   \item{item_flavor_summaries}{what the thing is}
#'   \item{item_flavor_text}{what the thing is}
#'   \item{item_fling_effect_prose}{what the thing is}
#'   \item{item_fling_effects}{what the thing is}
#'   \item{item_game_indices}{what the thing is}
#'   \item{item_names}{what the thing is}
#'   \item{item_pocket_names}{what the thing is}
#'   \item{item_pockets}{what the thing is}
#'   \item{item_prose}{what the thing is}
#'   \item{items}{what the thing is}
#'   \item{language_names}{what the thing is}
#'   \item{languages}{what the thing is}
#'   \item{location_area_encounter_rates}{what the thing is}
#'   \item{location_area_prose}{what the thing is}
#'   \item{location_areas}{what the thing is}
#'   \item{location_game_indices}{what the thing is}
#'   \item{location_names}{what the thing is}
#'   \item{locations}{what the thing is}
#'   \item{machines}{what the thing is}
#'   \item{move_battle_style_prose}{what the thing is}
#'   \item{move_battle_styles}{what the thing is}
#'   \item{move_changelog}{what the thing is}
#'   \item{move_damage_class_prose}{what the thing is}
#'   \item{move_damage_classes}{what the thing is}
#'   \item{move_effect_changelog_prose}{what the thing is}
#'   \item{move_effect_changelog}{what the thing is}
#'   \item{move_effect_prose}{what the thing is}
#'   \item{move_effects}{what the thing is}
#'   \item{move_flag_map}{what the thing is}
#'   \item{move_flag_prose}{what the thing is}
#'   \item{move_flags}{what the thing is}
#'   \item{move_flavor_summaries}{what the thing is}
#'   \item{move_flavor_text}{what the thing is}
#'   \item{move_meta_ailment_names}{what the thing is}
#'   \item{move_meta_ailments}{what the thing is}
#'   \item{move_meta_categories}{what the thing is}
#'   \item{move_meta_category_prose}{what the thing is}
#'   \item{move_meta_stat_changes}{what the thing is}
#'   \item{move_meta}{what the thing is}
#'   \item{move_names}{what the thing is}
#'   \item{move_target_prose}{what the thing is}
#'   \item{move_targets}{what the thing is}
#'   \item{moves}{what the thing is}
#'   \item{nature_battle_style_preferences}{what the thing is}
#'   \item{nature_names}{what the thing is}
#'   \item{nature_pokeathlon_stats}{what the thing is}
#'   \item{natures}{what the thing is}
#'   \item{pal_park_area_names}{what the thing is}
#'   \item{pal_park_areas}{what the thing is}
#'   \item{pal_park}{what the thing is}
#'   \item{pokeathlon_stat_names}{what the thing is}
#'   \item{pokeathlon_stats}{what the thing is}
#'   \item{pokedex_prose}{what the thing is}
#'   \item{pokedex_version_groups}{what the thing is}
#'   \item{pokedexes}{what the thing is}
#'   \item{pokemon_abilities}{what the thing is}
#'   \item{pokemon_color_names}{what the thing is}
#'   \item{pokemon_colors}{what the thing is}
#'   \item{pokemon_dex_numbers}{what the thing is}
#'   \item{pokemon_egg_groups}{what the thing is}
#'   \item{pokemon_evolution}{How a Pokemon evolution is triggered}
#'   \item{pokemon_form_generations}{what the thing is}
#'   \item{pokemon_form_names}{what the thing is}
#'   \item{pokemon_form_pokeathlon_stats}{what the thing is}
#'   \item{pokemon_forms}{what the thing is}
#'   \item{pokemon_game_indices}{what the thing is}
#'   \item{pokemon_habitat_names}{what the thing is}
#'   \item{pokemon_habitats}{what the thing is}
#'   \item{pokemon_items}{what the thing is}
#'   \item{pokemon_move_method_prose}{what the thing is}
#'   \item{pokemon_move_methods}{what the thing is}
#'   \item{pokemon_moves}{what the thing is}
#'   \item{pokemon_shape_prose}{what the thing is}
#'   \item{pokemon_shapes}{what the thing is}
#'   \item{pokemon_species_flavor_summaries}{what the thing is}
#'   \item{pokemon_species_flavor_text}{what the thing is}
#'   \item{pokemon_species_names}{The common and species names of the Pokemon in multiple langauges}
#'   \item{pokemon_species_prose}{what the thing is}
#'   \item{pokemon_species}{Evolution chains and physical descriptors}
#'   \item{pokemon_stats}{what the thing is}
#'   \item{pokemon_types}{what the thing is}
#'   \item{pokemon}{the actual pokemon}
#'   \item{region_names}{what the thing is}
#'   \item{regions}{what the thing is}
#'   \item{stat_names}{what the thing is}
#'   \item{stats}{what the thing is}
#'   \item{super_contest_combos}{what the thing is}
#'   \item{super_contest_effect_prose}{what the thing is}
#'   \item{super_contest_effects}{what the thing is}
#'   \item{type_efficacy}{what the thing is}
#'   \item{type_game_indices}{what the thing is}
#'   \item{type_names}{what the thing is}
#'   \item{types}{what the thing is}
#'   \item{version_group_pokemon_move_methods}{what the thing is}
#'   \item{version_group_regions}{what the thing is}
#'   \item{version_groups}{what the thing is}
#'   \item{version_names}{what the thing is}
#'   \item{versions}{what the thing is}
#' }
#' @source \url{https://github.com/veekun/pokedex}
"pokedex"

#' @title Pokemon specific data, in a tidy format
#' @description An extract from the pokedex of relevant data on specific pokemon. Each Pokemon is in it's own row. Some columns are nested information for that particular Pokemon
#' @format A data frame with 807 rows and 24 variables:
#' \describe{
#'   \item{\code{id}}{double COLUMN_DESCRIPTION}
#'   \item{\code{identifier}}{character COLUMN_DESCRIPTION}
#'   \item{\code{species_id}}{double COLUMN_DESCRIPTION}
#'   \item{\code{height}}{double COLUMN_DESCRIPTION}
#'   \item{\code{weight}}{double COLUMN_DESCRIPTION}
#'   \item{\code{base_experience}}{double COLUMN_DESCRIPTION}
#'   \item{\code{is_default}}{double COLUMN_DESCRIPTION}
#'   \item{\code{hp}}{double COLUMN_DESCRIPTION}
#'   \item{\code{attack}}{double COLUMN_DESCRIPTION}
#'   \item{\code{defense}}{double COLUMN_DESCRIPTION}
#'   \item{\code{special_attack}}{double COLUMN_DESCRIPTION}
#'   \item{\code{special_defense}}{double COLUMN_DESCRIPTION}
#'   \item{\code{speed}}{double COLUMN_DESCRIPTION}
#'   \item{\code{type_1}}{character COLUMN_DESCRIPTION}
#'   \item{\code{type_2}}{character COLUMN_DESCRIPTION}
#'   \item{\code{flavour_text}}{list COLUMN_DESCRIPTION}
#'   \item{\code{name}}{character COLUMN_DESCRIPTION}
#'   \item{\code{genus}}{character COLUMN_DESCRIPTION}
#'   \item{\code{generation_id}}{double COLUMN_DESCRIPTION}
#'   \item{\code{evolves_from_species_id}}{double COLUMN_DESCRIPTION}
#'   \item{\code{evolution_chain_id}}{double COLUMN_DESCRIPTION}
#'   \item{\code{color}}{character COLUMN_DESCRIPTION}
#'   \item{\code{shape}}{character COLUMN_DESCRIPTION}
#'   \item{\code{habitat}}{character COLUMN_DESCRIPTION}
#'}
#' @source \url{https://github.com/veekun/pokedex}
"pokemon"

#' @title DATASET_TITLE
#' @description DATASET_DESCRIPTION
#' @format A data frame with 324 rows and 3 variables:
#' \describe{
#'   \item{\code{identifier_damage}}{character the type of damage of the move}
#'   \item{\code{identifier_target}}{character the type of the pokemon being attacked}
#'   \item{\code{damage_factor}}{double mutliplier}
#'}
#' @source \url{https://github.com/veekun/pokedex}
"type_damage"

#' @title DATASET_TITLE
#' @description DATASET_DESCRIPTION
#' @format A data frame with 57 rows and 3 variables:
#' \describe{
#'   \item{\code{colour}}{character COLUMN_DESCRIPTION}
#'   \item{\code{type}}{character COLUMN_DESCRIPTION}
#'   \item{\code{colour_var}}{character COLUMN_DESCRIPTION}
#'}
#' @details DETAILS
"type_colours"