Skip to content

docs

🦠🧬💻 Project Title

This repository contains scripts and additional data for XYZ.

The manuscript can be found at

Title
B Baggins, G The Gray
bioRxiv 202X.Y; doi: https://doi.org/XYZ

Repository organization

[project root]
├─ step1.rmd      # individual analysis steps
├─ step2.rmd
├─ data           # contains additional and generated data
│  ├─ data.csv
│  ├─ ...
├─ figures        # generated figures
│  ├─ fig1.png
│  └─ ...
└─ docs
   ├─ step1.html  # rendered and executed notebooks
   └─ step2.html

Setup and installation

You will need a working miniforge or miniconda to start. You can follow the installation instructions here. After create an environment with the included conda environment file.

Start by cloning the repository and cd-ing into it.

git clone https://github.com/dienerlab/template
cd template
conda env create -f conda.yml

After that activate the environment.

conda activate template

Reproduce the analysis

1 - Preprocess the data | 📓 notebook | 📊 output

Aliqua magna nulla nulla laboris ipsum minim ad eu ipsum. Duis mollit sunt amet ex velit proident culpa dolor enim nostrud. Esse anim consequat minim aute proident reprehenderit in excepteur aliquip. Irure veniam elit elit do officia.

2 - Run the analysis for Figure 1 | 📓 notebook | 📊 output

Aliqua magna nulla nulla laboris ipsum minim ad eu ipsum. Duis mollit sunt amet ex velit proident culpa dolor enim nostrud. Esse anim consequat minim aute proident reprehenderit in excepteur aliquip. Irure veniam elit elit do officia.

Getting help

For bug reports or feature request please submit an issue.

For general questions or getting help you can open a discussion topic.