README.Rmd

---
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%"
)
```

# `randolist` <img src='man/figures/logo.png' align="right" width="200">

<!-- badges: start -->

`r badger::badge_custom("dev version", as.character(packageVersion("randolist")), "blue", "https://github.com/CTU-Bern/randolist")`
[![R-CMD-check](https://github.com/CTU-Bern/randolist/workflows/R-CMD-check/badge.svg)](https://github.com/CTU-Bern/randolist/actions)

<!-- badges: end -->

`randolist` contains home-grown functions for creating randomisation lists in R.

## Installation

You can install the development version of `randolist` from github with:

<!-- install.packages("randolist") -->

``` r
remotes::install_github("CTU-Bern/randolist")
```

<!-- Or from CTU Bern's package universe -->

<!-- ``` r -->
<!-- install.packages("randolist", repos = c('https://ctu-bern.r-universe.dev', 'https://cloud.r-project.org')) -->
<!-- ``` -->

## Generating randomization lists

Load the package

```{r}
library(randolist)
```


### Unstratified randomization

Where no strata are defined, the `blockrand` function can be used to create a randomization list. 

```{r}
blockrand(n = 10, 
          blocksizes = 1:2)
```

The treatment label is set via the `arms` argument.

Block sizes are defined via the `blocksizes` argument. The above example creates a randomization list with blocks of 1 or 2 *of each arm* (so in practice, the block sizes are 2 and 4).

Allocation schemes beyond 1:1 randomization are possible by specifying the `arms` argument, specifically by using the same arm label multiple times.

```{r}
blockrand(n = 10, 
          blocksizes = 1:2,
          arms = c("A", "A", "B"))
```