https://github.com/r-multiverse/multitools
Tools for contributing packages to R-multiverse
https://github.com/r-multiverse/multitools
Last synced: 4 months ago
JSON representation
Tools for contributing packages to R-multiverse
- Host: GitHub
- URL: https://github.com/r-multiverse/multitools
- Owner: r-multiverse
- License: other
- Created: 2024-03-14T12:06:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-29T14:20:34.000Z (11 months ago)
- Last Synced: 2024-05-30T04:11:10.562Z (11 months ago)
- Language: R
- Homepage: https://r-multiverse.org/multitools
- Size: 4.18 MB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - r-multiverse/multitools - Tools for contributing packages to R-multiverse (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
eval = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# multitools: tools for contributing packages to R-multiverse 
[](https://www.repostatus.org/#active)
[](https://github.com/r-multiverse/multitools/actions?query=workflow%3Acheck)
[](https://app.codecov.io/gh/r-multiverse/multitools)
[](https://github.com/r-multiverse/multitools/actions?query=workflow%3Alint)
[](https://github.com/r-multiverse/multitools/actions?query=workflow%3Apkgdown)
[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 for documentation, including a function reference.
# Code of Conduct
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 and general questions to .
# Installation
For the development version:
```{r, eval = FALSE}
remotes::install_github("r-multiverse/multitools")
```
For the latest release:
```{r, eval = FALSE}
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:
```{r, eval = FALSE}
check_versions()
#> # A tibble: 2 × 5
#> package version_current version_highest hash_current hash_highest
#>
#> 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
```{r, eval = FALSE, warning = FALSE, comment = ""}
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,
.
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/},
}
```