Skip to content

Commit

Permalink
Update README_template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sreichl authored Sep 12, 2024
1 parent 5fb040f commit 58e3b99
Showing 1 changed file with 22 additions and 25 deletions.
47 changes: 22 additions & 25 deletions README_template.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,23 @@
[![DOI](https://zenodo.org/badge/XXXXXX.svg)](https://zenodo.org/badge/latestdoi/XXXXXX)

# Analysis & Visualization Snakemake Workflow Using/Powered by PACKAGE for DATA/MODALITY
A [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow for performing and visualizing analyses of data (e.g., ...) powered by the package [package](https://www.packageURL.org).

This workflow adheres to the module specifications of [MR.PARETO](https://github.com/epigen/mr.pareto), an effort to augment research by modularizing (biomedical) data science. For more details, instructions, and modules check out the project's repository. Please consider **starring** and sharing modules that are interesting or useful to you, this helps others find and benefit from my work and me to prioritize my efforts!
> [!NOTE]
> This workflow adheres to the module specifications of [MR.PARETO](https://github.com/epigen/mr.pareto), an effort to augment research by modularizing (biomedical) data science. For more details, instructions, and modules check out the project's repository.
>
> ⭐️ Star and 📤 share modules you find valuable — help others discover them, and guide our focus for future work!
**If you use this workflow in a publication, don't forget to give credits to the authors by citing the URL of this (original) repository (and its DOI, see Zenodo badge above -> coming soon).**
> [!IMPORTANT]
> **If you use this workflow in a publication, please don't forget to give credit to the authors by citing it using this DOI [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX).**
![Workflow Rulegraph](./workflow/dags/rulegraph.svg)

Table of contents
----------------
* [Authors](#authors)
* [Software](#software)
* [Methods](#methods)
* [Features](#features)
* [Usage](#usage)
* [Configuration](#configuration)
* [Examples](#examples)
* [Links](#links)
* [Resources](#resources)
* [Publications](#publications)

# Authors
# 🖋️ Authors
- [MR.PARETO](https://github.com/epigen/mr.pareto)


# Software
# 💿 Software
This project is designed to run on top of the [Snakemake workflow management system](https://snakemake.readthedocs.io/en/stable/) and has been tested against the Snakemake version listed in the table below. In addition this project depends on, and is made possible by, the following Software:

| Software | Reference (DOI) |
Expand All @@ -34,7 +27,7 @@ This project is designed to run on top of the [Snakemake workflow management sys
| packageB | https://doi.org/10.BBBB/ |


# Methods
# 🔬 Methods
This is a template for the Methods section of a scientific publication and is intended to serve as a starting point. Only retain paragraphs relevant to your analysis. References [ref] to the respective publications are curated in the software table above. Versions (ver) have to be read out from the respective conda environment specifications (workflow/envs/\*.yaml file) or post execution in the result directory (/envs/{module}/\*.yaml). Parameters that have to be adapted depending on the data or workflow configurations are denoted in squared brackets e.g., [X].

__Analysis.__ Analysis was performed...
Expand All @@ -44,7 +37,7 @@ __Visualization.__ The results were visualized...

**The analysis and visualizations described here were performed using a publicly available Snakemake [ver] (ref) workflow [ref - cite this workflow here].**

# Features
# 🚀 Features
The workflow performs the following steps that produce the outlined results:

- Analysis
Expand All @@ -56,27 +49,31 @@ The workflow performs the following steps that produce the outlined results:
- ...


# Usage
# 🛠️ Usage
Here are some tips for the usage of this workflow:
- ...

# Configuration
# ⚙️ Configuration
Detailed specifications can be found here [./config/README.md](./config/README.md)

# Examples
# 📖 Examples
--- COMING SOON ---

# Links
# 🔗 Links
- [GitHub Repository](https://github.com/user/module/)
- [GitHub Page](https://user.github.io/module/)
- [Zenodo Repository (coming soon)]()
- [Snakemake Workflow Catalog Entry](https://snakemake.github.io/snakemake-workflow-catalog?usage=user/module)

# Resources
# 📚 Resources
- Recommended [MR.PARETO](https://github.com/epigen/mr.pareto) modules for up-/downstream analyses:
- ...
- ...

# Publications
# 📑 Publications
The following publications successfully used this module for their analyses.
- ...

# ⭐ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=epigen/atacseq_pipeline&Date)

0 comments on commit 58e3b99

Please sign in to comment.