Skip to content

Commit

Permalink
Merge pull request #7 from r-multiverse/rename
Browse files Browse the repository at this point in the history
More name changes
  • Loading branch information
wlandau authored Mar 21, 2024
2 parents f618504 + a1c08d8 commit 2e46e6c
Show file tree
Hide file tree
Showing 14 changed files with 58 additions and 59 deletions.
12 changes: 6 additions & 6 deletions R/check_versions.R
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
#' @title Check package version etiquette.
#' @export
#' @description Check the etiquette of versions of packages in R-releases.
#' @description Check the etiquette of versions of packages in R-multiverse.
#' @details It is good practice to increment the version number of a
#' package on every new release. [check_versions()]
#' list the packages that have chosen to decrement the version number
#' or keep it the same over the course of the release cycle.
#' To fix the version number of an R-releases package that you
#' To fix the version number of an R-multiverse package that you
#' maintain, create a new GitHub/GitLab release whose version number
#' in the `DESCRIPTION` file is higher than the one
#' in the `version_highest` column in the output of [check_versions()].
#' @return A `tibble` with one row per package and the following columns:
#' * `package`: name of the package.
#' * `version_current`: version number of the latest package release.
#' * `version_highest`: highest version number across all the releases
#' created since the package was registered with R-releases.
#' created since the package was registered with R-multiverse.
#' * `hash_current`: the `RemoteSha` of the release corresponding to
#' `version_current`.
#' * `hash_highest`: the `RemoteSha` of the release corresponding to
#' `version_highest`.
#' @examples
#' if (identical(Sys.getenv("RELEASES_EXAMPLES"), "true")) {
#' if (identical(Sys.getenv("MULTITOOLS_EXAMPLES"), "true")) {
#' check_versions()
#' }
check_versions <- function() {
manifest <- file.path(
"https://raw.githubusercontent.com",
"r-releases",
"r-releases.r-universe.dev",
"r-multiverse",
"r-multiverse.r-universe.dev",
"main",
"version_issues.json"
)
Expand Down
41 changes: 20 additions & 21 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,44 +12,44 @@ knitr::opts_chunk$set(
)
```

# releases: tools for R-releases <img src='man/figures/logo-readme.png' align="right" height="139"/>
# multitools: tools for contributing packages to R-multiverse <img src='man/figures/logo-readme.png' align="right" height="139"/>

<!-- badges: start -->
[![status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![check](https://github.com/r-releases/releases/actions/workflows/check.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Acheck)
[![codecov](https://codecov.io/gh/r-releases/releases/branch/main/graph/badge.svg?token=3T5DlLwUVl)](https://app.codecov.io/gh/r-releases/releases)
[![lint](https://github.com/r-releases/releases/actions/workflows/lint.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Alint)
[![pkgdown](https://github.com/r-releases/releases/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Apkgdown)
[![check](https://github.com/r-multiverse/multitools/actions/workflows/check.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Acheck)
[![codecov](https://codecov.io/gh/r-multiverse/multitools/branch/main/graph/badge.svg?token=3T5DlLwUVl)](https://app.codecov.io/gh/r-multiverse/multitools)
[![lint](https://github.com/r-multiverse/multitools/actions/workflows/lint.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Alint)
[![pkgdown](https://github.com/r-multiverse/multitools/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Apkgdown)
<!-- badges: end -->

[R-releases](https://github.com/r-releases/help) is a community-curated, maintainer-driven repository of R package releases based on [R-universe](https://r-universe.dev). The `releases` package has tools for maintainers of packages in [R-releases](https://github.com/r-releases/help).
[R-multiverse](https://r-multiverse.org) is a community-curated, maintainer-driven repository of R package releases based on [R-universe](https://r-universe.dev). The `multitools` package has tools for maintainers of packages in [R-multiverse](https://github.com/r-multiverse/help).

# Documentation

Please see <https://r-releases.github.io/releases> for documentation, including a function reference.
Please see <https://r-multiverse.org/multitools> for documentation, including a function reference.

# Code of Conduct

Please note that the `releases` project is released with a [Contributor Code of Conduct](https://r-releases.github.io/conduct.html). By contributing to this project, you agree to abide by its terms.
Please note that the `multitools` project is released with a [Contributor Code of Conduct](https://r-multiverse.org/conduct.html). By contributing to this project, you agree to abide by its terms.

# Help

Please post bug reports to <https://github.com/r-releases/help/issues> and general questions to <https://github.com/r-releases/help/discussions>.
Please post bug reports to <https://github.com/r-multiverse/help/issues> and general questions to <https://github.com/r-multiverse/help/discussions>.

# Installation

For the development version:

```{r, eval = FALSE}
remotes::install_github("r-releases/releases")
remotes::install_github("r-multiverse/multitools")
```

For the latest release:

```{r, eval = FALSE}
install.packages(
"releases",
repos = c("https://r-releases.r-universe.dev", getOption("repos"))
"multitools",
repos = c("https://r-multiverse.r-universe.dev", getOption("repos"))
)
```

Expand All @@ -68,24 +68,23 @@ check_versions()

Package `pkg.a` was flagged because the current version is lower than the highest version ever released. Package `pkg.b` was flagged because there are two different releases under version 3.0.0.

To fix the version number of an R-releases package that you maintain, create a new GitHub/GitLab release whose version number in the `DESCRIPTION` file is higher than the one in the `version_highest` column in the output of `check_releases()`.
To fix the version number of an R-multiverse package that you maintain, create a new GitHub/GitLab release whose version number in the `DESCRIPTION` file is higher than the one in the `version_highest` column in the output of `check_versions()`.

# Citation

```{r, eval = FALSE, warning = FALSE, comment = ""}
o cite package ‘releases’ in publications use:
o cite package ‘multitools’ in publications use:
Landau WM, Gao C, Revilla Sancho L (2024). _releases: Tools for Package
Releases_. R package version 0.0.1,
https://github.com/r-releases/releases,
<https://r-releases.github.io/releases/>.
Landau WM, Gao C, Revilla Sancho L (2024). _multitools: Tools for Contributing Packages to R-multiverse_. R package version 0.1.0,
https://github.com/r-multiverse/multitools,
<https://r-multiverse.org/multitools/>.
A BibTeX entry for LaTeX users is
@Manual{,
title = {releases: Tools for Package Releases},
title = {multitools: Tools for Contributing Packages to R-multiverse},
author = {William Michael Landau and Charlie Gao and Lluís {Revilla Sancho}},
note = {R package version 0.0.1, https://github.com/r-releases/releases},
url = {https://r-releases.github.io/releases/},
note = {R package version 0.0.1, https://github.com/r-multiverse/multitools},
url = {https://r-multiverse.org/multitools/},
}
```
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,52 @@

# releases: tools for R-releases <img src='man/figures/logo-readme.png' align="right" height="139"/>
# multitools: tools for contributing packages to R-multiverse <img src='man/figures/logo-readme.png' align="right" height="139"/>

<!-- badges: start -->

[![status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![check](https://github.com/r-releases/releases/actions/workflows/check.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Acheck)
[![codecov](https://codecov.io/gh/r-releases/releases/branch/main/graph/badge.svg?token=3T5DlLwUVl)](https://app.codecov.io/gh/r-releases/releases)
[![lint](https://github.com/r-releases/releases/actions/workflows/lint.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Alint)
[![pkgdown](https://github.com/r-releases/releases/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-releases/releases/actions?query=workflow%3Apkgdown)
[![check](https://github.com/r-multiverse/multitools/actions/workflows/check.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Acheck)
[![codecov](https://codecov.io/gh/r-multiverse/multitools/branch/main/graph/badge.svg?token=3T5DlLwUVl)](https://app.codecov.io/gh/r-multiverse/multitools)
[![lint](https://github.com/r-multiverse/multitools/actions/workflows/lint.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Alint)
[![pkgdown](https://github.com/r-multiverse/multitools/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-multiverse/multitools/actions?query=workflow%3Apkgdown)
<!-- badges: end -->

[R-releases](https://github.com/r-releases/help) is a community-curated,
[R-multiverse](https://r-multiverse.org) is a community-curated,
maintainer-driven repository of R package releases based on
[R-universe](https://r-universe.dev). The `releases` package has tools
[R-universe](https://r-universe.dev). The `multitools` package has tools
for maintainers of packages in
[R-releases](https://github.com/r-releases/help).
[R-multiverse](https://github.com/r-multiverse/help).

# Documentation

Please see <https://r-releases.github.io/releases> for documentation,
Please see <https://r-multiverse.org/multitools> for documentation,
including a function reference.

# Code of Conduct

Please note that the `releases` project is released with a [Contributor
Code of Conduct](https://r-releases.github.io/conduct.html). By
Please note that the `multitools` project is released with a
[Contributor Code of Conduct](https://r-multiverse.org/conduct.html). By
contributing to this project, you agree to abide by its terms.

# Help

Please post bug reports to <https://github.com/r-releases/help/issues>
Please post bug reports to <https://github.com/r-multiverse/help/issues>
and general questions to
<https://github.com/r-releases/help/discussions>.
<https://github.com/r-multiverse/help/discussions>.

# Installation

For the development version:

``` r
remotes::install_github("r-releases/releases")
remotes::install_github("r-multiverse/multitools")
```

For the latest release:

``` r
install.packages(
"releases",
repos = c("https://r-releases.r-universe.dev", getOption("repos"))
"multitools",
repos = c("https://r-multiverse.r-universe.dev", getOption("repos"))
)
```

Expand All @@ -69,27 +70,26 @@ Package `pkg.a` was flagged because the current version is lower than
the highest version ever released. Package `pkg.b` was flagged because
there are two different releases under version 3.0.0.

To fix the version number of an R-releases package that you maintain,
To fix the version number of an R-multiverse package that you maintain,
create a new GitHub/GitLab release whose version number in the
`DESCRIPTION` file is higher than the one in the `version_highest`
column in the output of `check_releases()`.
column in the output of `check_versions()`.

# Citation

``` r
o cite packagereleasesin publications use:
o cite packagemultitoolsin publications use:

Landau WM, Gao C, Revilla Sancho L (2024). _releases: Tools for Package
Releases_. R package version 0.0.1,
https://github.com/r-releases/releases,
<https://r-releases.github.io/releases/>.
Landau WM, Gao C, Revilla Sancho L (2024). _multitools: Tools for Contributing Packages to R-multiverse_. R package version 0.1.0,
https://github.com/r-multiverse/multitools,
<https://r-multiverse.org/multitools/>.

A BibTeX entry for LaTeX users is

@Manual{,
title = {releases: Tools for Package Releases},
title = {multitools: Tools for Contributing Packages to R-multiverse},
author = {William Michael Landau and Charlie Gao and Lluís {Revilla Sancho}},
note = {R package version 0.0.1, https://github.com/r-releases/releases},
url = {https://r-releases.github.io/releases/},
note = {R package version 0.0.1, https://github.com/r-multiverse/multitools},
url = {https://r-multiverse.org/multitools/},
}
```
8 changes: 4 additions & 4 deletions man/check_versions.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/figures/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This license and copyright notice applies only to the logo images of the R-releases project.
This license and copyright notice applies only to the logo images of the R-multiverse project.
Please refer to other licenses and copyright notices for all other parts of the project,
such as the code and documentation.

R-releases logo images copyright (c) 2024 Eli Lilly and Company, Hibiki AI Limited
R-multiverse logo images copyright (c) 2024 Eli Lilly and Company, Hibiki AI Limited

Attribution-ShareAlike 4.0 International

Expand Down
Binary file modified pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon.ico
Binary file not shown.

0 comments on commit 2e46e6c

Please sign in to comment.