From 2f4a23468cb2b4e0b2acfda7ae44d3ead45ff25c Mon Sep 17 00:00:00 2001 From: Mauro Lepore Date: Sun, 8 Jun 2025 08:16:50 -0700 Subject: [PATCH] Even simpler README --- README.Rmd | 18 +++--------------- README.md | 20 +++++++++++++++----- 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/README.Rmd b/README.Rmd index 614433b..82fa36d 100644 --- a/README.Rmd +++ b/README.Rmd @@ -72,10 +72,9 @@ using [pkgdown](https://pkgdown.r-lib.org/). ## Example * `document_universe()` creates a data frame with documentation metadata of one or -more packages. -* `url_template` can take different templates for the manual and vignettes. -* `knitr::kable()` turns the URLs into clickable links. `DT::datatabe()` also -provides a search box. +more packages, i.e. the universe. +* You can then turn the URLs into clickable links with e.g. `knitr::kable()` or +`DT::datatabe()` (which also provides a search box). ```{r} library(dverse) @@ -88,17 +87,6 @@ template <- "https://{package}.tidyverse.org/reference/{topic}.html" docs <- document_universe(packages, template) docs -``` - -```{r} -#| eval: !r on_ci -#| echo: !r on_ci -DT::datatable(docs, escape = FALSE) -``` -```{r} -#| eval: !r on_ci -#| echo: !r on_ci knitr::kable(tail(docs)) ``` - diff --git a/README.md b/README.md index b5ecb74..591cf6b 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,10 @@ website, for example using [pkgdown](https://pkgdown.r-lib.org/). ## Example - `document_universe()` creates a data frame with documentation metadata - of one or more packages. -- `url_template` can take different templates for the manual and - vignettes. -- `knitr::kable()` turns the URLs into clickable links. `DT::datatabe()` - also provides a search box. + of one or more packages, i.e. the universe. +- You can then turn the URLs into clickable links with + e.g. `knitr::kable()` or `DT::datatabe()` (which also provides a + search box). ``` r library(dverse) @@ -97,4 +96,15 @@ docs #> 9 vign… glue #> 10 vign… tibble #> # ℹ 36 more rows + +knitr::kable(tail(docs)) ``` + +| topic | alias | title | concept | type | keyword | package | +|:---|:---|:---|:---|:---|:---|:---| +| tribble | tribble | Row-wise tibble creation | NA | help | NA | tibble | +| trim | trim | Trim a character vector | NA | help | NA | glue | +| trunc_mat | trunc_mat | Legacy printing | NA | help | internal | tibble | +| types | types | Column types | NA | vignette | NA | tibble | +| view | view | View an object | NA | help | NA | tibble | +| wrappers | wrappers | How to write a function that wraps glue | NA | vignette | NA | glue |