docs: add changelog and update readme

kanaverse · May 13, 2022 · 7c18a2a · 7c18a2a
1 parent 2a5f1b7
commit 7c18a2a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+## V1.2.0
+
+- Visually compare embeddings across annotations
+- with linked embeddings, you can now make lasso selections on any plot and the app automatically highlights these cells across all visualizations
+- save and restore state of the embedding from the gallery
+- export plots from the interface as png
+- drag and drop, and reorganize the gallery in any order you like
+
+![Linked Visualizations](assets/linked_visualization.gif)
+
+## V1.1.0
+
+- Support ADTs 
+To overlay normalized protein expression of a marker for any ADT tag, these are available as column annotations
+
+![ADT protein expression](./assets/adt_expr.gif)
+
+
+## V1.0.0
+
+- Full release of the application. 
+- Supports everything in [README](./README.md)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Single cell RNA-seq analysis in the browser
+# Kana: Single cell RNA-seq analysis in the browser
 
 ## Overview
 
@@ -32,19 +32,22 @@ Briefly, this involves:
 
 - Removal of low-quality cells 
 - Normalization and log-transformation
-- Modelling of the mean-variance trend across genes
+- Modeling of the mean-variance trend across genes
 - A principal components analysis on the highly variable genes
 - Clustering with graph-based methods
 - The usual dimensionality reductions (t-SNE/UMAP)
 - Marker detection for each cluster
 - Make custom cell selections and detect markers for this selection
 - Cell type annotation for each cluster across user selected reference datasets
 - Perform Integration or Batch correction using MNN correction. You can provide a single dataset containing multiple batches and specify the `batch` column in the cell annotations, or load multiple datasets where each dataset is considered a batch
+- ADT aware for Cite-seq data
 
 The interface provides a depiction of the dimensionality reduction of choice,
 a ranking of marker genes for the cluster of interest,
 and diagnostic plots from the individual analysis steps.
 
+**for release notes and changelog, [read here](./CHANGELOG.md)**
+
 ![Features](assets/pbmc_68k.png)
 
 **Tips and tricks:**

diff --git a/assets/adt_expr.gif b/assets/adt_expr.gif
diff --git a/assets/linked_visualization.gif b/assets/linked_visualization.gif