README.Rmd

---
output: github_document
---

# CTU Berns R Package universe <a href="https://ctu-bern.r-universe.dev/"><img src='logo.png' align="right" height="200"></a>

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

R package universes are similar a bit like mini-CRANs. 'The system automatically tracks registered git repositories containing R packages, builds binaries for Windows and MacOS, renders vignettes, and makes all data available through dashboards, feeds and APIs on personal subdomains'. 

CTU Berns universe is [here](https://ctu-bern.r-universe.dev).

## Packages in the universe

```{r , echo = FALSE, message = FALSE, results='hide'}
pkgs <- jsonlite::stream_in(url("https://ctu-bern.r-universe.dev/stats/descriptions/"))
pkgs <- pkgs[order(pkgs$Package), ]
pkgs$Description <- gsub("\n", " ", pkgs$Description, fixed = TRUE)

```

```{r pressure, echo=FALSE, results='asis'}
knitr::kable(do.call("rbind", lapply(pkgs$Package, function(x) {
  data.frame(package = glue::glue("[`{x}`]({pkgs$RemoteUrl[pkgs$Package == x]})"), 
             description = pkgs$Description[pkgs$Package == x],
             status = glue::glue(" ![](https://ctu-bern.r-universe.dev/badges/{x}) "))
  })))
```

## For users...

All vignettes are accessible via the [articles button](https://ctu-bern.r-universe.dev/ui#articles) on the universe page.

To use the universe, in R, do the following, which adds the universe to your list of repos (when installing packages, R will cycle through the repos until it finds the appropriate package)...

```{r, eval = FALSE}
options(repos = c(CTU = "https://ctu-bern.r-universe.dev",
                  CRAN = "https://cran.rstudio.com/"))
```

It is then possible to install universe packages as if they were CRAN packages...

```{r, eval = FALSE}
install.packages("accrualPlot")
```

Alternatively, you can install without setting the option:

```{r, eval = FALSE}
install.packages("accrualPlot", repos = "https://ctu-bern.r-universe.dev")
```

## For maintainers...

A dashboard of the included packages and build status can be found [here](https://ctu-bern.r-universe.dev/ui#builds). 

Briefly, packages should be added to [packages.json](packages.json). They are then tracked on [r-universe](https://github.com/r-universe/ctu-bern) and built each hour. [See here for further details of universes](https://ropensci.org/blog/2021/06/22/setup-runiverse/)


### Acknowledgements

The package logo was created with [`ggplot2`](https://ggplot2.tidyverse.org/) and [`hexSticker`](https://github.com/GuangchuangYu/hexSticker).