Skip to content

Commit

Permalink
add DOI to README and CITATION file
Browse files Browse the repository at this point in the history
  • Loading branch information
sreichl committed Oct 4, 2023
1 parent f273a0b commit 902ec25
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 @@ -19,6 +19,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.8405360.
description: >-
This DOI represents all versions, and will always
resolve to the latest one.
repository-code: 'https://github.com/epigen/unsupervised_analysis'
url: 'https://epigen.github.io/unsupervised_analysis/'
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/475465311.svg)](https://zenodo.org/badge/latestdoi/475465311)

# Unsupervised Analysis Workflow
A general purpose [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow to perform unsupervised analyses (dimensionality reduction and cluster analysis) and visualizations of high-dimensional data.

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 and modules check out the project's repository.

**If you use this workflow in a publication, please don't forget to give credit to the authors by citing it using this DOI [coming soon]().**
**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.8405360](https://doi.org/10.5281/zenodo.8405360).**

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

Expand Down Expand Up @@ -90,7 +92,7 @@ We validated/analyzed the clustering results by comparing them with all categori
**Cluster Validation - Internal Indices & MCDM using TOPSIS**
We performed internal cluster validation using six complementary indices: Silhouette, Calinski-Harabasz, C-index, Dunn index, Davis-Bouldin Score from the clusterCrit package (ver) [ref], and a weighted Bayesian Information Criterion (BIC) approach as described in [Reichl 2018 - Chapter 4.2.2 - Internal Indices](https://repositum.tuwien.at/handle/20.500.12708/3488). Due to computational cost, PCA results representing 90% of variance explained were used as input, and only a random sample proportion of [sample_proportion] was used. These internal cluster indices are linear, using Euclidean distance metrics. To rank all clustering results and [metadata_of_interest] from best to worst, we applied the Multiple-criteria decision-making (MCDM) method TOPSIS from the the Python package pymcdm (ver) [ref] to the internal cluster indices, as described in [Reichl 2018 - Chapter 4.3.1 - The Favorite Approach](https://repositum.tuwien.at/handle/20.500.12708/3488).

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


# Features
Expand Down Expand Up @@ -225,7 +227,7 @@ Leiden algorithm for clustering
# Links
- [GitHub Repository](https://github.com/epigen/unsupervised_analysis/)
- [GitHub Page](https://epigen.github.io/unsupervised_analysis/)
- [Zenodo Repository]()
- [Zenodo Repository](https://doi.org/10.5281/zenodo.8405360)
- [Snakemake Workflow Catalog Entry](https://snakemake.github.io/snakemake-workflow-catalog?usage=epigen/unsupervised_analysis)

# Resources
Expand Down

0 comments on commit 902ec25

Please sign in to comment.