Skip to content

Commit 661729c

Browse files
authored
Update README.md
1 parent aabb40c commit 661729c

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## DataMap: Visualizing Data Matrices in Your Browser
22

3-
To use this app, just visit this static [GitHub page](https://gexijin.github.io/datamap/) deployed from this repo via Actions. For large datasets, install it as an R package for local execution:
3+
To use this app, just visit this static [GitHub page](https://gexijin.github.io/datamap/) deployed from this repo. For large datasets, install it as an R package:
44
```{R}
55
install.packages("remotes")
66
remotes::install_github("gexijin/datamap", upgrade = "never")
77
datamap::run_app()
88
```
99

10-
DataMap is a secure, browser-based application for visualizing high-dimensional 'omics and other data matrices with heatmaps, PCA, and t-SNE. Built with Shiny and running entirely in your browser through Shinylive technology, DataMap ensures your data never leaves your device.
10+
DataMap is a secure, browser-based application for visualizing high-dimensional 'omics and other data matrices with heatmaps, PCA, and t-SNE. Built with R/Shiny using [shinylive](https://posit-dev.github.io/r-shinylive/), DataMap is a serverless app that ensures your data never leaves your device.
1111

1212
![heatmap](https://github.com/user-attachments/assets/b649808a-d8d3-4a84-94ed-bec42a9b8f81)
1313
![image](https://github.com/user-attachments/assets/cbdaaa45-e681-4cbd-b8ef-500b0c4b0b8a)
@@ -20,41 +20,42 @@ Quick start: watch a 2-min video on [**YouTube.**](https://youtu.be/9G508BxzjBk)
2020
## Features
2121

2222
- **Browser-based**: No installation required, runs completely in your browser
23-
- **Secure**: Your data stays on your device, never uploaded to any server
2423
- **Interactive Visualizations**:
2524
- Heatmaps with hierarchical clustering
2625
- Principal Component Analysis (PCA)
2726
- t-SNE (t-Distributed Stochastic Neighbor Embedding)
28-
- **Exportable**: Generate reproducible R code for your analysis
27+
- **Exportable**: Generate R code to reproduce the plots.
28+
- **Publication-ready plots**: Export as PNG or PDF formats
2929
- **Multiple File Formats**: Supports CSV, TSV, TXT, and Excel files
30-
- **Customizable**: Extensive visualization parameters
3130

3231
### Data Format Requirements
3332

3433
Your data should be organized in a matrix format where:
3534
- The first row must contain column headers
3635
- The first column may contain row identifiers.
3736
- Some columns can be categorical, which will be used to color rows.
38-
- Column annotation can be uploaded separately.
39-
37+
- Column annotation can be included in the data matrix or uploaded separately.
4038

4139
## FAQ
4240

4341
**Is my data secure?**
44-
Yes. DataMap runs entirely in your browser. Your data never leaves your device.
42+
Yes. DataMap runs entirely in your browser. After loading the app, it works fine even if you disconnect the internet.
4543

4644
**What browsers are supported?**
47-
Chrome, Firefox, Edge, and Safari (latest versions recommended).
45+
Chrome, Firefox (slower to load), Edge, and Safari.
4846

4947
**Can I use DataMap offline?**
50-
Yes, once loaded in your browser, DataMap can operate without an internet connection.
48+
Yes, once loaded in your browser, DataMap can operate without an internet connection. Alternatively, you can intsall DataMap as an R package.
5149

5250
**Limitations?**
53-
Slower in the browser when clustering 5000 rows or columns. Can take up to 2 minutes.
51+
Slower in the browser when clustering 5000 rows or columns. Can take up to 2 minutes. For large datasets, install and use it as an R package.
52+
53+
**Why did you write DataMap?**
54+
A. I love heatmaps. B. I wanted to do an vibe coding experiment. I prompted and Claude.ai 95% of the code. See my [blog](https://www.ge-lab.org/2025/04/21/extreme-vibe-coding-the-making-of-datamap/) on how DataMap was developed.
5455

55-
## How to Cite
56+
## Cite our preprint
5657

57-
If you use DataMap in your research, please cite it as:
58+
If you use DataMap in your research, please cite:
5859

5960
> Ge, X. (2025). DataMap: A Portable Application for Visualizing High-Dimensional Data, [arXiv:2504.08875](https://arxiv.org/abs/2504.08875), 2025.
6061

0 commit comments

Comments
 (0)