Skip to content

Commit 9fa628c

Browse files
authored
Update README.md
1 parent 76f5c1a commit 9fa628c

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

ves_ncls/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1+
# Cluster Analysis of Vesicle Morphology
12

3+
## 1. Overview
4+
5+
This project performs a cluster analysis on morphological data of vesicles to identify distinct structural groups. The analysis uses a dataset of 20 vesicle samples, characterized by a combination of numerical (e.g., 'TotalVol', 'NucVol', 'TotalLen') and categorical (e.g., 'Branch' type) features.
6+
7+
The primary methods employed include:
8+
* Log transformation for numerical features.
9+
* Gower's distance to handle mixed data types.
10+
* Hierarchical agglomerative clustering (complete linkage method).
11+
* Cluster identification based on a distance threshold of 0.4.
12+
* Visualization of results using a dendrogram and a 2D Multidimensional Scaling (MDS) plot.
13+
14+
This repository contains the Google Colab notebook used for the analysis.
15+
16+
## 2. Relationship to Academic Paper
17+
18+
This code and the accompanying notebook, `Cluster_Analysis_Morphology_Vesicle.ipynb`, are provided as supplementary material for the research paper:
19+
20+
**[Your Paper Title Here - e.g., "Automated Morphological Classification of Vesicles using Hierarchical Clustering"]**
21+
22+
*(Optional: Add authors, venue, or a link to the preprint/publication if available)*
23+
24+
The notebook allows for the full reproduction of the clustering results and visualizations presented in the paper.
25+
26+
## 3. File Structure
27+
28+
* `README.md`: This file.
29+
* `Cluster_Analysis_Morphology_Vesicle.ipynb`: The Google Colab notebook containing all Python code, analysis steps, and embedded data.
30+
* *(Optional: Add here if you have separate data files, figure outputs, etc. e.g., `figures/dendrogram.png`)*
31+
32+
## 4. Prerequisites and Dependencies
33+
34+
The analysis is performed in a Python environment. The key dependencies are:
35+
* Python 3.x
36+
* pandas
37+
* numpy
38+
* scipy (for spatial distance, cluster hierarchy)
39+
* gower
40+
* matplotlib (for plotting)
41+
* scikit-learn (for MDS)
42+
43+
The notebook includes a command to install the `gower` library:
44+
```bash
45+
!pip3 install gower

0 commit comments

Comments
 (0)