Skip to content

Commit d5b8c11

Browse files
committed
Rename
1 parent 6ac5b57 commit d5b8c11

13 files changed

+36
-36
lines changed

.Rbuildignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
^_pkgdown\.yml$
66
^README\.Rmd$
77
^\.travis\.yml$
8-
^docuverse\.Rproj$
8+
^dverse\.Rproj$
99
^\.Rproj\.user$
1010
^\.github$
1111
^CODE_OF_CONDUCT\.md$
1212
^vignettes/articles$
1313
^pkgdown$
14-
^docuverse\.Rproj$
14+
^dverse\.Rproj$
1515
^dverse\.Rproj$

DESCRIPTION

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Description: Creates a data frame of the metadata associated to the
88
meta-package, it helps you to easily create a universal reference for
99
its website.
1010
License: MIT + file LICENSE
11-
URL: https://github.com/maurolepore/docuverse,
12-
https://maurolepore.github.io/docuverse/
13-
BugReports: https://github.com/maurolepore/docuverse/issues
11+
URL: https://github.com/maurolepore/dverse,
12+
https://maurolepore.github.io/dverse/
13+
BugReports: https://github.com/maurolepore/dverse/issues
1414
Depends:
1515
R (>= 3.1)
1616
Imports:

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
YEAR: 2024
2-
COPYRIGHT HOLDER: docuverse authors
2+
COPYRIGHT HOLDER: dverse authors

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MIT License
22

3-
Copyright (c) 2024 docuverse authors
3+
Copyright (c) 2024 dverse authors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

R/document_universe.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Create a data.frame with documentation metadata of one or more packages
22
#'
33
#' Create a data.frame with documentation metadata of one or more packages. If
4-
#' you develop a universe, such as the tidyverse or tidymodels, docuverse helps you
4+
#' you develop a universe, such as the tidyverse or tidymodels, dverse helps you
55
#' to easily create a universe-wide reference for the pkgdown website of your
66
#' meta-package.
77
#'

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11

22
<!-- README.md is generated from README.Rmd. Please edit that file -->
33

4-
# docuverse
4+
# dverse
55

66
<!-- badges: start -->
77

8-
[![R-CMD-check](https://github.com/maurolepore/docuverse/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maurolepore/docuverse/actions/workflows/R-CMD-check.yaml)
8+
[![R-CMD-check](https://github.com/maurolepore/dverse/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maurolepore/dverse/actions/workflows/R-CMD-check.yaml)
99
<!-- badges: end -->
1010

11-
The goal of docuverse is to make it easy to create a data frame of the
11+
The goal of dverse is to make it easy to create a data frame of the
1212
metadata associated to the documentation of a collection of R packages.
1313

1414
If you maintain an R-package universe, it helps you to easily create a
@@ -19,14 +19,14 @@ universe-wide reference for the pkgdown website of your meta-package
1919

2020
``` r
2121
# install.packages("pak")
22-
pak::pak("maurolepore/docuverse")
22+
pak::pak("maurolepore/dverse")
2323
```
2424

2525
## Example
2626

2727
``` r
28-
# Use docuverse and the universe of packages you want to document
29-
library(docuverse)
28+
# Use dverse and the universe of packages you want to document
29+
library(dverse)
3030
library(tools)
3131
library(datasets)
3232

_pkgdown.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
url: https://maurolepore.github.io/docuverse/
1+
url: https://maurolepore.github.io/dverse/
22
template:
33
bootstrap: 5
44

@@ -20,7 +20,7 @@ navbar:
2020
text: "Articles"
2121
menu:
2222
- text: "Get started"
23-
href: articles/docuverse.html
23+
href: articles/dverse.html
2424
news:
2525
text: "Changelog"
2626
href: news/index.html

man/document_universe.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/dverse-package.Rd

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/testthat.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
# * https://testthat.r-lib.org/articles/special-files.html
88

99
library(testthat)
10-
library(docuverse)
10+
library(dverse)
1111

12-
test_check("docuverse")
12+
test_check("dverse")

tests/testthat/test-document_universe.R

+5-5
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@ test_that("by default srips teh class of S3 methods", {
4646
})
4747

4848
test_that("doesn't include the package-level documentation", {
49-
out <- document_universe("docuverse")
50-
expect_false(any(grepl("docuverse-package", unique(out$alias))))
49+
out <- document_universe("dverse")
50+
expect_false(any(grepl("dverse-package", unique(out$alias))))
5151
})
5252

5353
test_that("takes a `url_template`", {
5454
url_template <- "https://maurolepore.github.io/{package}/reference/{topic}.html"
55-
out <- document_universe("docuverse", url_template = url_template)
56-
expect_true(grepl("docuverse", out$topic[[1]]))
55+
out <- document_universe("dverse", url_template = url_template)
56+
expect_true(grepl("dverse", out$topic[[1]]))
5757
})
5858

5959
test_that("with bad `url_template` errors gracefully", {
6060
bad <- "https://{bad}/{topic}.html"
61-
expect_error(document_universe("docuverse", url_template = bad), "not found")
61+
expect_error(document_universe("dverse", url_template = bad), "not found")
6262
})

vignettes/articles/docuverse.Rmd

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "docuverse"
2+
title: "dverse"
33
---
44

55
```{r, include = FALSE}
@@ -13,8 +13,8 @@ knitr::opts_chunk$set(
1313

1414
```{r}
1515
library(dplyr, warn.conflicts = FALSE)
16-
# Use docuverse and the universe of packages you want to document
17-
library(docuverse)
16+
# Use dverse and the universe of packages you want to document
17+
library(dverse)
1818
library(tools)
1919
library(datasets)
2020
@@ -81,12 +81,12 @@ by_package |> custom_table(search = "Utilities")
8181

8282
### Presentation
8383

84-
In a meta-package, you may use docuverse in an article, then use it to [override
84+
In a meta-package, you may use dverse in an article, then use it to [override
8585
the default Reference
8686
component](https://pkgdown.r-lib.org/articles/customise.html#navbar-heading).
8787

8888
For an example see the pkgdown Reference of
89-
[docuverse](https://maurolepore.github.io/docuverse/) and follow the link to its
89+
[dverse](https://maurolepore.github.io/dverse/) and follow the link to its
9090
source and see how it's configured in
91-
[_pkgdown.yml](https://github.com/maurolepore/docuverse/blob/main/_pkgdown.yml).
91+
[_pkgdown.yml](https://github.com/maurolepore/dverse/blob/main/_pkgdown.yml).
9292

vignettes/articles/reference.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ knitr::opts_chunk$set(
1212
```
1313

1414
```{r setup}
15-
library(docuverse)
15+
library(dverse)
1616
library(dplyr)
1717
library(knitr)
1818
@@ -22,7 +22,7 @@ custom_table <- function(data) {
2222
}
2323
2424
link <- "https://maurolepore.github.io/{package}/reference/{topic}.html"
25-
docs <- document_universe("docuverse", url_template = link)
25+
docs <- document_universe("dverse", url_template = link)
2626
```
2727

2828
### Main

0 commit comments

Comments
 (0)