0.9.2 versionb

frankligy · Oct 24, 2021 · a71e240 · a71e240
1 parent 1efd2cc
commit a71e240
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 2 deletions.
diff --git a/docs/change_log.rst b/docs/change_log.rst
@@ -1,6 +1,11 @@
 Change Log
 ============
 
+Version 0.9.2 2021/10/23
+
+1. ``Feature Enhancement`` Add Build_custom_continous_cmap() and Build_custom_divergent_cmap() function
+2. Polish the documentation and fix and typos
+
 Version 0.9.1 2021/10/10
 -------------------------
 

diff --git a/image/colors_module/README.md b/image/colors_module/README.md
@@ -1,12 +1,47 @@
 # scTriangulate colors module
 
-## An One Stop solutions for any color related problem in Python
+## An One Stop solutions for any color related problems in Python
 
 As a seperate module in scTriangulate, `colors` module contains several handy functions for the tasks that you may frequently encounter in your analysis. If you have any feature request, please let me know and I will implement and add them to the modules.
 
 ### pick_n_colors
 
 Imagining you just want to have `n` discrete colors to represent `n` differnet entities, the entity can be different categories, different batches, different countries, etc. This function will do the job for you, `n` can be any arbitrary interger.
 
-See [pick_n_colors]
+See [pick_n_colors](https://sctriangulate.readthedocs.io/en/latest/api.html#pick-n-colors) API for more details.
+
+![pick_n_colors](./pick_n_colors.png)
+
+### colors_for_set
+
+Similar to the scenario as `pick_n_colors`, but if you want to obtain a dictionary/mapping of your entities to the colors, this function do the job for you.
+
+See [colors_for_set](https://sctriangulate.readthedocs.io/en/latest/api.html#colors-for-set) for more details.
+
+![colors_for_set](./colors_for_set.png)
+
+### build_custom_continuous_cmap
+
+So this function allows you to build any custom continous colormap at your own wills.
+
+See [build_custom_continuous_cmap](https://sctriangulate.readthedocs.io/en/latest/api.html#build-custom-continuous-cmap) API for more details.
+
+![build_custom_continuous_cmap](./custom_continuous_cmap.png)
+
+### build_custom_divergent_cmap
+
+This function allows you to build any custom divergent colormap at your own wills.
+
+See [build_custom_divergent_cmap](https://sctriangulate.readthedocs.io/en/latest/api.html#build-custom-divergent-cmap) API for more details.
+
+![build_custom_divergent_cmap](./custom_divergent_cmap.png)
+
+## bg_greyed_cmap
+
+This function can make the any matplotlib colormap object's background grey.
+
+See [bg_greyed_cmap](https://sctriangulate.readthedocs.io/en/latest/api.html#bg-greyed-cmap)
+
+![bg_greyed_cmap](./bg_greyed_cmap.png)
+
 
diff --git a/image/colors_module/bg_greyed_cmap.png b/image/colors_module/bg_greyed_cmap.png
diff --git a/image/colors_module/colors_for_set.png b/image/colors_module/colors_for_set.png
diff --git a/image/colors_module/custom_continuous_cmap.png b/image/colors_module/custom_continuous_cmap.png
diff --git a/image/colors_module/custom_divergent_cmap.png b/image/colors_module/custom_divergent_cmap.png