multitools: tools for contributing packages to R-multiverse

R-multiverse is a community-curated, maintainer-driven repository of R package releases based on R-universe. The multitools package has tools for maintainers of packages in R-multiverse.

Documentation

Please see https://r-multiverse.org/multitools for documentation, including a function reference.

Code of Conduct

Please note that the multitools project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Help

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:

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

For the latest release:

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

Version etiquette

It is good practice to increment the version number of a package on every new release. The 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. For example:

check_versions()
#> # A tibble: 2 × 5
#>   package version_current version_highest hash_current                  hash_highest
#>   <chr>   <chr>           <chr>           <chr>                         <chr>       
#> 1 pkg.a   1.0.0           2.0.0           1f9928593251410322823fefea8c… 8e7f9fe32c4…
#> 2 pkg.b   3.0.0           3.0.0           7f608bde8f0e308aa8866d737dde… e59165f73b7…

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-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

To cite package ‘multitools’ in publications use:

  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 = {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-multiverse/multitools},
    url = {https://r-multiverse.org/multitools/},
  }

shikokuchuo / multitools