-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
90 lines (65 loc) · 3.93 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
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 <img src='man/figures/logo-readme.png' align="right" height="139"/>
<!-- badges: start -->
[](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)
<!-- badges: end -->
[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-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](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-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-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
#> <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
```{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,
<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/},
}
```