Skip to contents

Installation

Source: vignettes/installation.qmd

R

From GitHub:

install.packages("remotes")
remotes::install_github("tidywf/tidydragen") # latest main commit
remotes::install_github("tidywf/tidydragen@v0.1.0") # specific version

Conda

conda-versionconda-latest

conda create -n tidydragen_env -c tidywf -c conda-forge r-tidydragen==0.1.0
conda activate tidydragen_env

Docker

ghcr-latestghcr-size

docker pull --platform linux/amd64 ghcr.io/tidywf/tidydragen:0.1.0

Docker Compose

docker-compose.yaml mounts ./in (read-only) and ./out, and tidies to parquet:

mkdir -p in out
docker compose run --rm tidydragen

Env vars (or .env): IMAGE_TAG (default: pinned pkg version), IN_DIR, OUT_DIR, FORMAT (parquet | tsv | csv | rds). ENTRYPOINT is tidydragen.R, so extra args pass through:

IN_DIR=/path/to/samples docker compose run --rm tidydragen tidy -d /data/in -o /data/out -f tsv

Pixi

With Pixi:

pixi init -c tidywf -c conda-forge ./tidy_env
cd ./tidy_env
pixi add r-tidydragen==0.1.0

CLI task:

pixi task add tidydragen "tidydragen.R"
pixi run tidydragen --help

Or from R:

pixi shell
R
library(tidydragen)