README.Rmd

---
output:
  github_document:
    toc: true
    toc_depth: 3
    includes:
      before_body: README-header.md
always_allow_html: yes
editor_options:
  markdown:
    wrap: sentence
---

```{r include = FALSE}
oldhook <- knitr::knit_hooks$get("source")
knitr::knit_hooks$set(source = function(x, options) {
  oldhook(sub("await import('./index.js')", "require('rversions')", x, fixed = TRUE), options)
})
knitr::opts_chunk$set(engine.opts = list(node = "--input-type=module"))
```

## Install

```
$ npm install rversions
```

## Usage

### R-devel

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("devel"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("devel", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("devel", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("devel", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("devel", "linux-ubuntu-22.04", "arm64"));
```

### R-next

This can be an alpha, beta, RC or pre-release if a release process is
currently happenning. Otherwise it is the current patched version.

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("next"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("next", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("next", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("next", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("next", "linux-ubuntu-22.04", "arm64"));
```

### R-release

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("release"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("release", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("release", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("release", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("release", "linux-ubuntu-22.04", "arm64"));
```

### R-oldrel

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("oldrel/1"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("oldrel/1", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("oldrel/1", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("oldrel/1", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("oldrel/1", "linux-ubuntu-22.04", "arm64"));
```

### Specific R version

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.2.2"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.2.2", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.2.2", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.2.2", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.2.2", "linux-ubuntu-22.04", "arm64"));
```

### Minor R version

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.1"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.1", "win"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.1", "macos"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.1", "linux-ubuntu-22.04"));
```

```{node}
const rversions = await import('./index.js');
console.log(await rversions.resolve("4.1", "linux-ubuntu-22.04", "arm64"));
```

## All R releases

```{node}
const rversions = await import('./index.js');
console.log(await rversions.r_versions());
```

## Rtools versions

```{node}
const rversions = await import('./index.js');
console.log(await rversions.rtools_versions());
```

## Supported Linux distros for R builds

```{node}
const rversions = await import('./index.js');
console.log(await rversions.linux_distros());
```

## Caching

All queries are cached for five minutes by default. If you don't want to
use the cached value, then set the (first) cache argument to `false`.

You can adjust the default caching time limit by setting the
`R_VERSIONS_CACHE_LIMIT` environment variable in milliseconds. E.g. the
default five minutes is 5 * 60 * 1000 = 300000.

## License

ISC @ R Consortium

This repo is part of the R-hub project, supported by
the R Consortium.