Skip to content

Commit

Permalink
add DOI to README and CITATION.cff
Browse files Browse the repository at this point in the history
  • Loading branch information
sreichl committed Mar 21, 2024
1 parent d0e4676 commit 1ee59ed
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
6 changes: 6 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ authors:
family-names: Bock
orcid: 'https://orcid.org/0000-0001-6091-3088'
affiliation: CeMM Research Center for Molecular Medicine
identifiers:
- type: doi
value: 10.5281/zenodo.10849097
description: >-
This DOI represents all versions, and will always
resolve to the latest one.
repository-code: 'https://github.com/epigen/genome_tracks'
url: 'https://epigen.github.io/genome_tracks'
abstract: >-
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[![DOI](https://zenodo.org/badge/438573546.svg)](https://zenodo.org/doi/10.5281/zenodo.10849097)

# Genome Browser Track Visualization Workflow
A [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow for easy visualization of genome browser tracks of aligned/mapped BAM files (e.g., RNA-seq, ATAC-seq, scRNA-seq, ...) powered by the wrapper [gtracks](https://gitlab.com/salk-tm/gtracks) for the package [pyGenomeTracks](https://github.com/deeptools/pyGenomeTracks) and [IGV-reports](https://github.com/igvteam/igv-reports).

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 me in prioritizing my efforts!

**If you use this workflow in a publication, please don't forget to give credits to the authors by citing this DOI [10.5281/zenodo.XXXXX](https://zenodo.org/doi/10.5281/zenodo.XXXXX).**
**If you use this workflow in a publication, please don't forget to give credits to the authors by citing this DOI [10.5281/zenodo.10849097](https://zenodo.org/doi/10.5281/zenodo.10849097).**

![Workflow Rulegraph](./workflow/dags/rulegraph.svg)

Expand Down Expand Up @@ -46,7 +48,7 @@ __Processing.__ Aligned (filtered, and indexed) BAM files were merged by [group]

__Visualization.__ Visualizations for each relevant gene/genomic region and [category] were generated by using the generated bigWig coverage files and vertically stacking genome browser tracks with their annotation at the [x_axis] and each track scaled by [y_max] reads. The plotting was performed using the python wrapper gtracks (ver) [ref] for the package pyGenomeTracks (ver) [ref]. Additionally, an interactive self-contained IGV-report containing all merged samples and gene/genomic regions of interest was generated using igv-reports (ver) [ref]. Finally, a UCSC genome browser track hub was created for online sharing and inspection using [UCSC Genome Browser](https://genome.ucsc.edu/). Both the plotted tracks and the UCSC genome browser tracks were color coded according to [group].

**The processing and visualizations described here were performed using a publicly available Snakemake [ver] (ref) workflow [[10.5281/zenodo.XXXXX](https://zenodo.org/doi/10.5281/zenodo.XXXXX)].**
**The processing and visualizations described here were performed using a publicly available Snakemake [ver] (ref) workflow [[10.5281/zenodo.10849097](https://zenodo.org/doi/10.5281/zenodo.10849097)].**

# Features
The workflow performs the following steps to produce the outlined results (`genome_tracks/`).
Expand Down Expand Up @@ -107,7 +109,7 @@ The `bigWigs` directory contains the read coverage per sample/group in bigWig fo
# Links
- [GitHub Repository](https://github.com/epigen/genome_tracks/)
- [GitHub Page](https://epigen.github.io/genome_tracks/)
- [Zenodo Repository](https://zenodo.org/doi/10.5281/zenodo.XXXXX)
- [Zenodo Repository](https://zenodo.org/doi/10.5281/zenodo.10849097)
- [Snakemake Workflow Catalog Entry](https://snakemake.github.io/snakemake-workflow-catalog?usage=epigen/genome_tracks)

# Resources
Expand Down

0 comments on commit 1ee59ed

Please sign in to comment.