* document_universe() now outputs the new column type. (#18)

* * New column type to differenciates vignette

* Test type vignette

* Turn article into vignette

* Test with dverse

* Pick helpfiles

* fixme

* refactor

* refactor

* * Do not link articles

* test

* style

* Refactor

* Show helpfiles

* Make article

* Polish

* Prune

* Spellcheck

Author: maurolepore

DESCRIPTION

@@ -25,7 +25,8 @@ Imports:
 Suggests: 
     DT,
     knitr,
-    testthat
+    testthat,
+    withr
 Config/Needs/website: rmarkdown
 Config/testthat/edition: 3
 Encoding: UTF-8

R/document_universe.R

@@ -1,11 +1,18 @@
 document_universe_impl <- function(x, url_template = NULL) {
   warn_unnattached(x)
-  pick <- pick_doc(x = x)
+  pick <- pick_doc(x)
 
-  out <- tidy_reference(may_add_url(pick, url = NULL), strip_s3class = TRUE)
+  out <- tidy_reference(pick, strip_s3class = TRUE)
 
   if (!is.null(url_template)) {
-    out <- mutate(out, topic = paste0("<a href=", glue::glue(url_template), ">", .data$topic, "</a>"))
+    out <- mutate(
+      out,
+      topic = ifelse(
+        .data$type == "help",
+        paste0("<a href=", glue::glue(url_template), ">", .data$topic, "</a>"),
+        .data$topic
+      )
+    )
   }
 
   out
@@ -59,7 +66,7 @@ pick_doc <- function(x) {
 
 tidy_reference <- function(data, strip_s3class) {
   out <- collapse_alias(data, strip_s3class)
-  out <- select(out, c("topic", "alias", "title", "concept", "package"))
+  out <- select(out, c("topic", "alias", "title", "concept", "type", "package"))
   out <- arrange(out, .data$alias)
   out
 }
@@ -98,20 +105,3 @@ collapse_alias <- function(data, strip_s3class = FALSE) {
 may_strip_s3class <- function(x, .f = s3_strip_class) {
   paste(unique(.f(x)), collapse = ", ")
 }
-
-may_add_url <- function(x, url) {
-  if (is.null(url)) {
-    return(unique(x))
-  }
-  unique(link_topic(x, url))
-}
-
-link_topic <- function(data, url) {
-  out <- mutate(
-    data,
-    topic   = glue("<a href={url}{package}/reference/{topic}>?</a>"),
-    package = glue("<a href={url}{package}>{package}</a>")
-  )
-
-  arrange(out, .data$package)
-}

README.md

@@ -77,20 +77,20 @@ url_template <- "https://{package}.tidyverse.org/reference/{topic}.html"
 docs <- dverse::document_universe(packages, url_template)
 
 docs
-#> # A tibble: 35 × 5
-#>    topic                                             alias title concept package
-#>    <chr>                                             <chr> <chr> <chr>   <chr>  
-#>  1 <a href=https://tibble.tidyverse.org/reference/a… add_… Add … additi… tibble 
-#>  2 <a href=https://tibble.tidyverse.org/reference/a… add_… Add … additi… tibble 
-#>  3 <a href=https://glue.tidyverse.org/reference/as_… as_g… Coer… <NA>    glue   
-#>  4 <a href=https://tibble.tidyverse.org/reference/a… as_t… Coer… <NA>    tibble 
-#>  5 <a href=https://tibble.tidyverse.org/reference/c… char… Form… vector… tibble 
-#>  6 <a href=https://tibble.tidyverse.org/reference/d… digi… Comp… <NA>    tibble 
-#>  7 <a href=https://tibble.tidyverse.org/reference/e… enfr… Conv… <NA>    tibble 
-#>  8 <a href=https://tibble.tidyverse.org/reference/e… exte… Exte… <NA>    tibble 
-#>  9 <a href=https://tibble.tidyverse.org/reference/f… form… Colu… <NA>    tibble 
-#> 10 <a href=https://tibble.tidyverse.org/reference/f… form… Prin… <NA>    tibble 
-#> # ℹ 25 more rows
+#> # A tibble: 39 × 6
+#>    topic                                       alias title concept type  package
+#>    <chr>                                       <chr> <chr> <chr>   <chr> <chr>  
+#>  1 <a href=https://tibble.tidyverse.org/refer… add_… Add … additi… help  tibble 
+#>  2 <a href=https://tibble.tidyverse.org/refer… add_… Add … additi… help  tibble 
+#>  3 <a href=https://glue.tidyverse.org/referen… as_g… Coer… <NA>    help  glue   
+#>  4 <a href=https://tibble.tidyverse.org/refer… as_t… Coer… <NA>    help  tibble 
+#>  5 <a href=https://tibble.tidyverse.org/refer… char… Form… vector… help  tibble 
+#>  6 <a href=https://tibble.tidyverse.org/refer… digi… Comp… <NA>    vign… tibble 
+#>  7 <a href=https://tibble.tidyverse.org/refer… enfr… Conv… <NA>    help  tibble 
+#>  8 <a href=https://glue.tidyverse.org/referen… engi… Cust… <NA>    vign… glue   
+#>  9 <a href=https://tibble.tidyverse.org/refer… exte… Exte… <NA>    vign… tibble 
+#> 10 <a href=https://tibble.tidyverse.org/refer… form… Colu… <NA>    vign… tibble 
+#> # ℹ 29 more rows
 ```
 
 `knitr::kable()` turns the URLs into clickable links.
@@ -99,11 +99,11 @@ docs
 knitr::kable(head(docs, 3))
 ```
 
-| topic | alias | title | concept | package |
-|:---|:---|:---|:---|:---|
-| <a href=https://tibble.tidyverse.org/reference/add_column.html>add_column</a> | add_column | Add columns to a data frame | addition | tibble |
-| <a href=https://tibble.tidyverse.org/reference/add_row.html>add_row</a> | add_row, add_case | Add rows to a data frame | addition | tibble |
-| <a href=https://glue.tidyverse.org/reference/as_glue.html>as_glue</a> | as_glue | Coerce object to glue | NA | glue |
+| topic | alias | title | concept | type | package |
+|:---|:---|:---|:---|:---|:---|
+| <a href=https://tibble.tidyverse.org/reference/add_column.html>add_column</a> | add_column | Add columns to a data frame | addition | help | tibble |
+| <a href=https://tibble.tidyverse.org/reference/add_row.html>add_row</a> | add_row, add_case | Add rows to a data frame | addition | help | tibble |
+| <a href=https://glue.tidyverse.org/reference/as_glue.html>as_glue</a> | as_glue | Coerce object to glue | NA | help | glue |
 
 `DT::datatabe()` also provides a search box. See [Get
 started](https://maurolepore.github.io/dverse/articles/dverse.html).

inst/WORDLIST

@@ -3,9 +3,9 @@ Codecov
 Lifecycle
 ORCID
 Tidyverse
-funcitons
+dplyr
+ggplot
 pkgdown
 tibble
 tidymodels
 tidyverse
-yml

tests/testthat/test-document_universe.R

@@ -10,7 +10,7 @@ test_that("yields the expected tbl", {
   out <- document_universe(c("datasets"))
 
   expect_s3_class(out, "tbl")
-  expect_named(out, c("topic", "alias", "title", "concept", "package"))
+  expect_named(out, c("topic", "alias", "title", "concept", "type", "package"))
   are_type <- unlist(unique(lapply(out, typeof)))
   expect_equal(are_type, "character")
 })
@@ -31,8 +31,9 @@ test_that("with no url creates no link", {
 })
 
 test_that("with a url creates a link", {
-  out <- document_universe("datasets", url = "https://blah")$topic[[1]]
-  expect_true(grepl("href", out))
+  out <- document_universe("datasets", url = "https://blah")
+  topic <- out[out$type == "help", "topic"]$topic
+  expect_true(all(grepl("href", topic)))
 })
 
 test_that("srips the class of S3 methods", {
@@ -56,3 +57,17 @@ test_that("with bad `url_template` errors gracefully", {
   bad <- "https://{bad}/{topic}.html"
   expect_error(document_universe("dverse", url_template = bad), "not found")
 })
+
+test_that("vignettes lack a link", {
+  # Not using dverse because on developer mode there are no vignettes
+  withr::local_package("tibble")
+  type <- "vignette"
+  out <- document_universe("tibble", url_template = "some/url")
+  topic <- out[out$type == type, ]$topic
+
+  # Error if there is no vignette
+  expect_false(rlang::is_empty(topic))
+
+  has_link <- any(grepl("href", topic))
+  expect_false(has_link)
+})

vignettes/articles/dverse.Rmd

@@ -25,10 +25,12 @@ docs
 ```
 
 Pick rows and columns to organize the documentation however you like (e.g. by
-`package` or `concept`).
+`package` or `type`).
 
 ```{r}
-pick <- docs[c("topic", "title", "package")]
+rows <- docs$type == "help"
+cols <- c("topic", "title", "package")
+pick <- docs[rows, cols]
 ```
 
 You may generate a clickable table with `DT::datatable()`, which offers great