Skip to content

Commit 0a6d2d6

Browse files
committed
Polish README
1 parent e9914f3 commit 0a6d2d6

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.Rmd

+4-6
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,8 @@ using [pkgdown](https://pkgdown.r-lib.org/).
6969

7070
## Example
7171

72-
* `dverse::document_universe()` creates a data frame with the documentation of a
73-
collection of packages.
74-
* `url_template` links each `{topic}` in each `{package}` with its corresponding
75-
documentation online.
72+
`document_universe()` creates a data frame with documentation metadata of one or
73+
more packages.
7674

7775
```{r}
7876
library(glue)
@@ -85,10 +83,10 @@ docs <- dverse::document_universe(packages, url_template)
8583
docs
8684
```
8785

88-
* `knitr::kable()` turns the URLs into clickable links.
86+
`knitr::kable()` turns the URLs into clickable links.
8987

9088
```{r}
9189
knitr::kable(head(docs, 3))
9290
```
9391

94-
* `DT::datatabe()` also provides a search box. See [Get started](https://maurolepore.github.io/dverse/articles/dverse.html).
92+
`DT::datatabe()` also provides a search box. See [Get started](https://maurolepore.github.io/dverse/articles/dverse.html).

0 commit comments

Comments
 (0)