Skip to content

Even simpler README #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maurolepore merged 2 commits into from
Jun 8, 2025
Merged

Even simpler README #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f4a234
Even simpler README
maurolepore Jun 8, 2025
1405ad5
Merge remote-tracking branch 'refs/remotes/origin/main'
maurolepore Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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))
```

20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -97,4 +96,15 @@ docs
#> 9 <a href=https://glue.tidyverse.org… engi… Cust… <NA> vign… <NA> glue
#> 10 <a href=https://tibble.tidyverse.o… exte… Exte… <NA> vign… <NA> tibble
#> # ℹ 36 more rows

knitr::kable(tail(docs))
```

| topic | alias | title | concept | type | keyword | package |
|:---|:---|:---|:---|:---|:---|:---|
| <a href=https://tibble.tidyverse.org/reference/tribble.html>tribble</a> | tribble | Row-wise tibble creation | NA | help | NA | tibble |
| <a href=https://glue.tidyverse.org/reference/trim.html>trim</a> | trim | Trim a character vector | NA | help | NA | glue |
| <a href=https://tibble.tidyverse.org/reference/trunc_mat.html>trunc_mat</a> | trunc_mat | Legacy printing | NA | help | internal | tibble |
| <a href=https://tibble.tidyverse.org/articles/types.html>types</a> | types | Column types | NA | vignette | NA | tibble |
| <a href=https://tibble.tidyverse.org/reference/view.html>view</a> | view | View an object | NA | help | NA | tibble |
| <a href=https://glue.tidyverse.org/articles/wrappers.html>wrappers</a> | wrappers | How to write a function that wraps glue | NA | vignette | NA | glue |