Introduction

See BEST-PRACTICES.md for repository layout and coding best practices. Particularly, this repository has been setup to use uv for Python dependency management and renv for R dependency management. Additionally, a Conda-compatible tool (such as micromamba, mamba or conda) can be used to set up compatible versions of R, Python and uv if these are not already available on the system.

Thus, to get the project running, do the following:

1. Ensure you have compatible versions of R and uv available on the system.
2. Install R dependencies with Rscript -e 'renv::restore()'
3. Install Python dependencies with uv sync

For quick-start introductions on how to use the data in practice from code, look at src/example_user/example_analysis.Rmd andsrc/example_user/example_analysis.ipynb.