Skip to content

README_SRC.md

Latest commit

 

History

History
103 lines (70 loc) · 6.46 KB

README_SRC.md

File metadata and controls

103 lines (70 loc) · 6.46 KB

ZekDex -- This is the source file of the README.md to be compiled into the README.md

ZekDex is a comprehensive R package that serves as a rich resource for Pokémon enthusiasts and data scientists alike. It offers a wide array of datasets about Pokémon, encompassing a multitude of aspects that make these creatures unique.

Key features of ZekDex include:

  • National Dex Information: This provides a complete listing of Pokémon as per the National Dex, which is a catalogue of Pokémon species in the order they were discovered.
  • Legendary and Mythical Pokémon Groupings: This categorizes Pokémon into their respective Legendary and Mythical groups, offering insights into their rarity and special attributes.
  • Base Stats: This includes the fundamental statistics of each Pokémon, such as their attack power, defense, speed, and more per generation.
  • Evolution and Family Information: This provides details about the evolutionary stages of Pokémon and their familial connections.
  • Random Pokémon Generation: ZekDex also includes functions that allow users to generate random Pokémon, adding an element of surprise and discovery.
  • And much more!

ZekDex is committed to providing up-to-date and accurate information about Pokémon. It draws its data from Bulbapedia, a community-driven Pokémon encyclopedia. As of the time of writing, ZekDex includes data for Pokémon generations I through IX.

One of the standout features of ZekDex is its ability to stay current. If the package's data ever falls behind, users have the capability to generate up-to-date information. This ensures that ZekDex remains a reliable and timely resource for Pokémon data.

Whether you're a researcher conducting a data analysis project, or a fan interested in the fascinating world of Pokémon, ZekDex is a valuable tool to have in your R library.

Data Formats and Accessibility

The datasets incorporated in this package are primarily stored in the .rda format, which is a binary format native to R. This format is particularly beneficial for R users as it allows for efficient storage and quick data loading, thereby enhancing the overall user experience with this package.

However, we understand that users might want to utilize this data outside the R environment. To cater to this need, we also provide the data in the universally recognized .csv format. These .csv files can be easily imported into various data analysis software and programming languages, offering users the flexibility to work with the data in an environment of their choice.

You can locate these .csv files in the /data directory of the package. This directory has been structured to ensure easy navigation and quick access to the required datasets.

In summary, whether you're working within the R ecosystem or venturing outside it, we've got you covered with our dual data format availability. Happy data exploring!

Installation

You can install the package from GitHub with:

# If devtools is not installed:
install.packages("devtools")

# Install the stable branch of the package ZekDex (recommended)
devtools::install_github("zekrom-vale/ZekDex", ref = "stable")

# Or, install the main branch of the package ZekDex (May be in an unusable state)
devtools::install_github("zekrom-vale/ZekDex", ref = "main")

Datasets

The package includes the following datasets: -- Perhaspse it is best to split this into another file {DATASETS} -- To be replaced with the datasets in R/data.R

You can load any dataset with the data() function. For example, data(nationalDex).

Functions

The package provides the following functions:

  • randomPokemon(): Returns a random Pokémon. This function takes the following parameters:

    • n (integer): How many Pokémon to return.
    • p (character): What column to return (ndex, name, form, regional, type, type2 can be used).
    • replace (logical): Should sampling be with replacement?

  • randomPokemonGen(): Returns a random Pokémon generator. This function takes the following parameters:

    • p (character): What column to return (ndex, name, form, regional, type, type2 can be used).
    • replace (logical): Should sampling be with replacement?
    • size (integer): The number of random Pokémon to generate on each call.

  • gen_*(): Regenerates parts of the dataset

    • write (logical): Should it write the data to a file? (Recomended to save the output as this takes time)
    • root (character): Where to look for files and write them
    • file (character): Where to save the data without extention if write == TRUE
    • file* (character): Same as file but for other datasets generated
    • NOTE: These functions scrape Bulbapedia, do not call them more then once. Save the data to file and use it, updating only when required.

License

This package is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (CC BY-NC-SA 4.0). This license allows for redistribution and adaptation of the work under the following terms:

  • Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  • NonCommercial: You may not use the material for commercial purposes.
  • ShareAlike: If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

This license is designed to protect the rights of the creators while also promoting openness and collaboration. It ensures that the package can be freely used and adapted, as long as appropriate credit is given and the work is not used for commercial purposes. Furthermore, any adaptations of the work must be shared under the same license, promoting the creation of derivative works that are also freely available.

For more details about the CC BY-NC-SA 4.0 license, you can visit the official webpage.

Additionally, you can refer to the LICENSE file included with the package. This file contains the full text of the license, providing a detailed description of the rights and restrictions associated with the use of the package.

Please ensure that you understand and comply with the terms of the license when using this package. If you have any questions about the license, it's recommended to consult with a legal expert.

{ATTRIBUTION} -- To be replaced with ATTRIBUTION.md