cosmetics

elbersb · Aug 6, 2019 · d4eff25 · d4eff25
1 parent 576a8bd
commit d4eff25
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 23 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,10 +1,10 @@
 Package: tidylog
 Type: Package
-Title: Logging for 'dplyr' Functions
+Title: Logging for 'dplyr' and 'tidyr' Functions
 Version: 0.1.0.9000
 Authors@R: person("Benjamin", "Elbers", email = "elbersb@gmail.com",
   role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5392-3448"))
-Description: Provides feedback about basic 'dplyr' operations.
+Description: Provides feedback about 'dplyr' and 'tidyr' operations.
 License: MIT + file LICENSE
 Imports: dplyr, tidyr, glue, clisymbols
 Suggests: testthat, covr, lintr

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,5 @@
 # 0.1.0.9000
-- wrap new functions for `tidyr::gather()`, `tidyr::spread()` (thanks [@WilDoane](https://github.com/WilDoane)) and `tidyr::drop_na()`([@jackhannah95](https://github.com/jackhannah95))
+- added supoort for tidyr functions: gather, spread, drop_na (thanks @WilDoane and @jackhannah95)
 - use clisymbols for ellipsis
 - add number of remaining rows to filter (#23)
 - bugfix: do not report negative NA (#18)

diff --git a/README.Rmd b/README.Rmd
@@ -18,7 +18,7 @@ knitr::opts_chunk$set(
 [![Build Status](https://travis-ci.org/elbersb/tidylog.svg?branch=master)](https://travis-ci.org/elbersb/tidylog)
 [![Coverage status](https://codecov.io/gh/elbersb/tidylog/branch/master/graph/badge.svg)](https://codecov.io/github/elbersb/tidylog?branch=master)
 
-The goal of tidylog is to provide feedback about basic dplyr and tidyr operations. It provides simple wrapper functions for the most common functions, such as `filter`, `mutate`, `select`, `full_join`, and `group_by`.
+The goal of tidylog is to provide feedback about dplyr and tidyr operations. It provides simple wrapper functions for the most common functions, such as `filter`, `mutate`, `select`, `full_join`, and `group_by`.
 
 ## Example
 
@@ -65,7 +65,7 @@ devtools::install_github("elbersb/tidylog")
 
 ## More examples
 
-### filter, distinct, drop_na (tidyr)
+### filter, distinct, drop_na
 
 ```{r}
 a <- filter(mtcars, mpg > 20)
@@ -134,7 +134,7 @@ c <- mtcars %>% count(gear, carb)
 d <- mtcars %>% add_count(gear, carb, name = "count")
 ```
 
-### gather, spread (tidyr)
+### gather, spread
 
 ```{r}
 long <- mtcars %>%
@@ -147,7 +147,7 @@ wide <- long %>%
 ## Turning logging off, registering additional loggers
 
 To turn off the output for just a particular function call, you can simply call the dplyr and tidyr functions
-directly, e.g. `dplyr::filter` and `tidyr::drop_na`.
+directly, e.g. `dplyr::filter` or `tidyr::drop_na`.
 
 To turn off the output more permanently, set the global option `tidylog.display` to an empty list:
 
@@ -166,7 +166,7 @@ simply overwrite the option:
 
 ```{r}
 library("crayon")  # for terminal colors
-crayon <- function(x) cat(red$bold(x), sep = "\n") 
+crayon <- function(x) cat(red$bold(x), sep = "\n")
 options("tidylog.display" = list(crayon))
 a <- filter(mtcars, mpg > 20)
 ```
@@ -184,11 +184,11 @@ a <- filter(mtcars, mpg > 20)
 Tidylog redefines several of the functions exported by dplyr and tidyr, so it should be loaded last, otherwise there will be no output. A more explicit way to resolve namespace conflicts is to use the [conflicted](https://CRAN.R-project.org/package=conflicted) package:
 
 ``` r
-library(dplyr)
-library(tidyr)
-library(tidylog)
-library(conflicted)
+library("dplyr")
+library("tidyr")
+library("tidylog")
+library("conflicted")
 for (f in getNamespaceExports("tidylog")) {
-    conflicted::conflict_prefer(f, 'tidylog', quiet = TRUE)
+    conflicted::conflict_prefer(f, "tidylog", quiet = TRUE)
 }
 ```
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Status](https://travis-ci.org/elbersb/tidylog.svg?branch=master)](https://travis
 [![Coverage
 status](https://codecov.io/gh/elbersb/tidylog/branch/master/graph/badge.svg)](https://codecov.io/github/elbersb/tidylog?branch=master)
 
-The goal of tidylog is to provide feedback about basic dplyr and tidyr
+The goal of tidylog is to provide feedback about dplyr and tidyr
 operations. It provides simple wrapper functions for the most common
 functions, such as `filter`, `mutate`, `select`, `full_join`, and
 `group_by`.
@@ -70,7 +70,7 @@ devtools::install_github("elbersb/tidylog")
 
 ## More examples
 
-### filter, distinct, drop\_na (tidyr)
+### filter, distinct, drop\_na
 
 ``` r
 a <- filter(mtcars, mpg > 20)
@@ -178,7 +178,7 @@ d <- mtcars %>% add_count(gear, carb, name = "count")
 #> add_count: new variable 'count' with 5 unique values and 0% NA
 ```
 
-### gather, spread (tidyr)
+### gather, spread
 
 ``` r
 long <- mtcars %>%
@@ -195,7 +195,7 @@ wide <- long %>%
 
 To turn off the output for just a particular function call, you can
 simply call the dplyr and tidyr functions directly, e.g. `dplyr::filter`
-and `tidyr::drop_na`.
+or `tidyr::drop_na`.
 
 To turn off the output more permanently, set the global option
 `tidylog.display` to an empty list:
@@ -217,7 +217,7 @@ output, simply overwrite the option:
 
 ``` r
 library("crayon")  # for terminal colors
-crayon <- function(x) cat(red$bold(x), sep = "\n") 
+crayon <- function(x) cat(red$bold(x), sep = "\n")
 options("tidylog.display" = list(crayon))
 a <- filter(mtcars, mpg > 20)
 #> filter: removed 18 rows (56%), 14 rows remaining
@@ -240,11 +240,11 @@ explicit way to resolve namespace conflicts is to use the
 [conflicted](https://CRAN.R-project.org/package=conflicted) package:
 
 ``` r
-library(dplyr)
-library(tidyr)
-library(tidylog)
-library(conflicted)
+library("dplyr")
+library("tidyr")
+library("tidylog")
+library("conflicted")
 for (f in getNamespaceExports("tidylog")) {
-    conflicted::conflict_prefer(f, 'tidylog', quiet = TRUE)
+    conflicted::conflict_prefer(f, "tidylog", quiet = TRUE)
 }
 ```
diff --git a/tests/testthat/test_gather.R → tests/testthat/test_gather_spread.R b/tests/testthat/test_gather.R → tests/testthat/test_gather_spread.R
@@ -1,4 +1,5 @@
 library("dplyr")
+library("tidyr")
 library("tidylog")
 context("test_gather")
 
@@ -28,3 +29,30 @@ test_that("gather: argument order", {
 
     expect_equal(out_ab, out_ba)
 })
+
+test_that("spread", {
+    expect_message({
+        outlog <- tidylog::spread(mtcars, hp, carb)
+    })
+    expect_equal(nrow(outlog), 32)
+    expect_equal(ncol(outlog), 31)
+
+    expect_silent({
+        outtidyr <- tidyr::spread(mtcars, hp, carb)
+    })
+
+    expect_equal(outlog, outtidyr)
+
+})
+
+test_that("spread: argument order", {
+    expect_message({
+        out_ab <- tidylog::spread(.data = mtcars, hp, carb)
+    })
+
+    expect_message({
+        out_ba <- tidylog::spread(hp, carb, .data = mtcars)
+    })
+
+    expect_equal(out_ab, out_ba)
+})