multiverse.internals/README.Rmd at main · r-multiverse/multiverse.internals · GitHub

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
---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# multiverse.internals

[![check](https://github.com/r-multiverse/multiverse.internals/actions/workflows/check.yaml/badge.svg)](https://github.com/r-multiverse/multiverse.internals/actions?query=workflow%3Acheck)

The `multiverse.internals` supports:

1. Interactive tools to help developers and moderators contribute packages to [R-multiverse](https://r-multiverse.org).
2. Internal infrastructure to support the automation that powers [R-multiverse](https://r-multiverse.org).

Please visit <https://r-multiverse.org/multiverse.internals/reference/index.html> for documentation.
To ask questions and post issues about this package or [R-multiverse](https://r-multiverse.org) in general, please visit <https://github.com/r-multiverse/help>.

## Installation

You can install the latest release of `multiverse.internals` from [R-multiverse](https://r-multiverse.org).

``` r
install.packages(
  "multiverse.internals",
  repos = c("https://community.r-multiverse.org", getOption("repos"))
)
```

You can install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("r-multiverse/multiverse.internals")
```

## Manual package reviews

The `review_package()` function helps contributors and moderators check packages for compliance with [R-multiverse policies](https://r-multiverse.org/policies.html).
It attempts to run all the checks at <https://r-multiverse.org/review.html#automatic-acceptance> which can be performed using the package name and URL alone.
These checks are not exhaustive, and it might not be feasible to run them all, but they do help with manual reviews.

```{r}
library(multiverse.internals)
review_package(
  name = "webchem",
  url = "https://github.com/ropensci/webchem"
)
```

```{r}
review_package(
  name = "polars",
  url = "https://github.com/pola-rs/r-polars"
)
```

Sometimes, `review_package()` may not be able to run all its checks.

```{r}
review_package(
  name = "wrongpackage",
  url = "https://github.com/ropensci/invalid-repo-name"
)
```

In those cases, it is critical to manually run `review_license()` on the `"License:"` string in the package's `DESCRIPTION` file.
[R-multiverse](https://r-multiverse.org) requires that each package has a valid free open-source (FOSS) license.

```{r}
review_license("MIT + file LICENSE")
```

```{r}
review_license("file LICENSE")
```