Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 5.84 KB

README_template.md

File metadata and controls

95 lines (70 loc) · 5.84 KB

MrBiomics DOI GitHub license GitHub Release Snakemake

Analysis & Visualization Workflow Using/Powered by PACKAGE for DATA/MODALITY

A Snakemake 8 workflow for performing and visualizing analyses of data (e.g., ...) powered by the package package.

Note

This workflow adheres to the module specifications of MrBiomics, 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 future work!

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.

Workflow Rulegraph

🖋️ Authors

💿 Software

This project wouldn't be possible without the following software and their dependencies.

Software Reference (DOI)
Snakemake https://doi.org/10.12688/f1000research.29032.2
packageA https://doi.org/10.AAA/
packageB https://doi.org/10.BBBB/

🔬 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 ({module}/envs/*.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...

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

The workflow performs the following steps that produce the outlined results:

  • Analysis
    • ...
    • (optional) ...
  • Visualizations
    • ...
  • Limitations
    • ...

🛠️ Usage

Here are some tips for the usage of this workflow:

  • ...

⚙️ Configuration

Detailed specifications can be found here ./config/README.md

📖 Examples

Explore detailed examples showcasing module usage in comprehensive end-to-end analyses (including data, configuration, annotation and results) in our MrBiomics Recipes:

🔗 Links

📚 Resources

📑 Publications

The following publications successfully used this module for their analyses.

⭐ Star History

Star History Chart