exokire 1.3.3.9005: use_data_wordle()

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: explore
 Title: Simplifies Exploratory Data Analysis
-Version: 1.3.3.9004
+Version: 1.3.3.9005
 Authors@R: 
     person("Roland", "Krasser", , "[email protected]", role = c("aut", "cre"))
 Description: Interactive data exploration with one line of code, automated

NAMESPACE

@@ -80,6 +80,7 @@ export(use_data_mtcars)
 export(use_data_penguins)
 export(use_data_starwars)
 export(use_data_titanic)
+export(use_data_wordle)
 export(weight_target)
 export(yyyymm_calc)
 import(dplyr)

NEWS.md

@@ -4,6 +4,7 @@
 
 * add `explore_col()` for simple bar plots without aggregation
 * add `yyyymm_calc()` for calculation with periods (format yyyymm)
+* add `use_data_wordle()`: data from a wordle challange
 * update vignette `abtest.Rmd`
 
 ## Bug fixes / internal

R/use-data.R

@@ -142,3 +142,21 @@ use_data_beer <- function() {
   # return data as tibble
   tibble::as_tibble(data)
 }
+
+#' Use the wordle data set
+#'
+#' This data set contains the result of a real wordle challange (in german language)
+#' between tow players. Wordle is a game where a player guesses a five-letter
+#' word in six tries. The variable "try" reflects the success of player A and B.
+#' Other variables like "noun", "aeiou", "unique", "common" and "rare" reflect
+#' the properties of the word.
+#' @return Dataset
+#' @examples
+#' use_data_wordle()
+#' @export
+
+use_data_wordle <- function() {
+  file <- system.file("extdata", "wordle.rds", package="explore")
+  data <- readRDS(file = file)
+  return(tibble::as_tibble(data))
+}

README.md

@@ -10,8 +10,10 @@
 Simplifies Exploratory Data Analysis:
 
 -   **Interactive data exploration** using `explore()`
+-   Use **AI** to unveil hidden patterns in your data (xgboost, RF, logreg, DT)
 -   Generate an **automated report** of your data (or patterns in your data) using `report()`
 -   **Manual exploration** using `explore()`, `describe()`, `explain_*()`, `abtest()`, ...
+-   Ready to use **Datasets for teaching & testing**
 
 ``` r
 # install from CRAN

tests/testthat/test-use-data.R

@@ -8,6 +8,7 @@ test_that("use_data returns a data frame.", {
   expect_s3_class(use_data_penguins(), "data.frame")
   expect_s3_class(use_data_titanic(), "data.frame")
   expect_s3_class(use_data_beer(), "data.frame")
+  expect_s3_class(use_data_wordle(), "data.frame")
 })
 
 # use_data returns data.frame with >0 rows ----------
@@ -20,6 +21,7 @@ test_that("use_data returns data frames with >0 rows", {
   expect_gt(nrow(use_data_penguins()), 0)
   expect_gt(nrow(use_data_titanic()), 0)
   expect_gt(nrow(use_data_beer()), 0)
+  expect_gt(nrow(use_data_wordle()), 0)
 })
 
 # use_data returns data.frame with >0 rows

vignettes/explore.Rmd

@@ -269,6 +269,7 @@ Use one of the prepared datasets to explore:
 * `use_data_penguins()`
 * `use_data_starwars()`
 * `use_data_titanic()`
+* `use_data_wordle()`
 
 ```{r message=FALSE, warning=FALSE, fig.width=6, fig.height=3}
 use_data_beer() %>% describe()