From ba98ef026544d4437e65a7bd248ff9591296b48e Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Wed, 13 Oct 2021 09:37:19 +0300
Subject: Add some documentation for generating heatmaps

Issue:
https://github.com/genenetwork/gn-gemtext-threads/blob/main/topics/gn1-migration-to-gn2/non-clustered-heatmaps-and-flipping.gmi

* Add some documentation on generating the heatmaps, that would be
  useful for the end user.
---
 doc/heatmap-generation.org              |  34 ++++++++++++++++++++++++++++++++
 doc/images/gn2_header_collections.png   | Bin 0 -> 7890 bytes
 doc/images/heatmap_form.png             | Bin 0 -> 9363 bytes
 doc/images/heatmap_with_hover_tools.png | Bin 0 -> 42578 bytes
 4 files changed, 34 insertions(+)
 create mode 100644 doc/heatmap-generation.org
 create mode 100644 doc/images/gn2_header_collections.png
 create mode 100644 doc/images/heatmap_form.png
 create mode 100644 doc/images/heatmap_with_hover_tools.png

(limited to 'doc')

diff --git a/doc/heatmap-generation.org b/doc/heatmap-generation.org
new file mode 100644
index 00000000..a697c70b
--- /dev/null
+++ b/doc/heatmap-generation.org
@@ -0,0 +1,34 @@
+#+STARTUP: inlineimages
+#+TITLE: Heatmap Generation
+#+AUTHOR: Muriithi Frederick Muriuki
+
+* Generating Heatmaps
+
+Like a lot of other features, the heatmap generation requires an existing collection. If none exists, see [[][Creating a new collection]] for how to create a new collection.
+
+Once you have a collection, you can navigate to the collections page by clicking on the "Collections" link in the header
+
+
+[[./images/gn2_header_collections.png]]
+
+From that page, pick the collection that you want to work with by clicking on its name on the collections table.
+
+That takes you to that collection's page, where you can select the data that you want to use to generate the heatmap.
+
+** Selecting Orientation
+
+Once you have selected the data, select the orientation of the heatmap you want generated. You do this by selecting either *"vertical"* or *"horizontal"* in the heatmaps form:
+
+[[./images/heatmap_form.png]]
+
+Once you have selected the orientation, click on the "Generate Heatmap" button as in the image above.
+
+The heatmap generation might take a while, but once it is done, an image shows up above the data table.
+
+** Downloading the PNG copy of the Heatmap
+
+Once the heatmap image is shown, hovering over it, displays some tools to interact with the image.
+
+To download, hover over the heatmap image, and click on the "Download plot as png" icon as shown.
+
+[[./images/heatmap_with_hover_tools.png]]
diff --git a/doc/images/gn2_header_collections.png b/doc/images/gn2_header_collections.png
new file mode 100644
index 00000000..ac23f9c1
Binary files /dev/null and b/doc/images/gn2_header_collections.png differ
diff --git a/doc/images/heatmap_form.png b/doc/images/heatmap_form.png
new file mode 100644
index 00000000..163fbb60
Binary files /dev/null and b/doc/images/heatmap_form.png differ
diff --git a/doc/images/heatmap_with_hover_tools.png b/doc/images/heatmap_with_hover_tools.png
new file mode 100644
index 00000000..4ab79f99
Binary files /dev/null and b/doc/images/heatmap_with_hover_tools.png differ
-- 
cgit v1.2.3