Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
daslu committed Jun 21, 2024
1 parent f30713b commit 71cc59e
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 27 deletions.
14 changes: 7 additions & 7 deletions docs/hanamicloth.walkthrough.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/hanamicloth.walkthrough_files/2.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
rownames,sepal-length,sepal-width,petal-length,petal-width,species
135,6.1,2.6,5.6,1.4,virginica
129,6.4,2.8,5.6,2.1,virginica
25,4.8,3.4,1.9,0.2,setosa
62,5.9,3.0,4.2,1.5,versicolor
27,5.0,3.4,1.6,0.4,setosa
144,6.8,3.2,5.9,2.3,virginica
112,6.4,2.7,5.3,1.9,virginica
132,7.9,3.8,6.4,2.0,virginica
66,6.7,3.1,4.4,1.4,versicolor
143,5.8,2.7,5.1,1.9,virginica
10 changes: 5 additions & 5 deletions docs/hanamicloth.walkthrough_files/3.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
rownames,sepal-length,sepal-width,petal-length,petal-width,species
36,5.0,3.2,1.2,0.2,setosa
67,5.6,3.0,4.5,1.5,versicolor
5,5.0,3.6,1.4,0.2,setosa
57,6.3,3.3,4.7,1.6,versicolor
111,6.5,3.2,5.1,2.0,virginica
145,6.7,3.3,5.7,2.5,virginica
26,5.0,3.0,1.6,0.2,setosa
126,7.2,3.2,6.0,1.8,virginica
123,7.7,2.8,6.7,2.0,virginica
61,5.0,2.0,3.5,1.0,versicolor
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,10 @@ <h1 class="title">Hanamicloth</h1>
<script src="index_files/md-default1.js" type="text/javascript"></script>
<section id="preface" class="level1" data-number="1">
<h1 data-number="1"><span class="header-section-number">1</span> Preface</h1>
<p>Hanamicloth is a composition of <a href="https://github.com/jsa-aerial/hanami">Hanami</a> data visualization <a href="https://github.com/jsa-aerial/hanami?tab=readme-ov-file#templates-substitution-keys-and-transformations">templates</a> and <a href="https://scicloj.github.io/tablecloth/">Tablecloth</a> datasets.</p>
<p><strong>Source:</strong> <a href="https://github.com/scicloj/hanamicloth"><img src="https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&amp;logo=github&amp;logoColor=white" class="img-fluid" alt="(GiuHub repo)"></a></p>
<p><strong>Artifact:</strong> <a href="https://clojars.org/org.scicloj/hanamicloth"><img src="https://img.shields.io/clojars/v/org.scicloj/hanamicloth.svg" class="img-fluid" alt="(Clojars coordinates)"></a></p>
<p><strong>Status:</strong> initial draft</p>
<p>Hanamicloth is a composition of <a href="https://github.com/jsa-aerial/hanami">Hanami</a> data visualization <a href="https://github.com/jsa-aerial/hanami?tab=readme-ov-file#templates-substitution-keys-and-transformations">templates</a> and <a href="https://scicloj.github.io/tablecloth/">Tablecloth</a> datasets.</p>
<p>It adds a simplified set of Hanami templates and defaults alongside those of Hanami, as well as a set of template-processing functions inspired by <a href="https://ggplot2.tidyverse.org/">ggplot2</a>’s <a href="https://vita.had.co.nz/papers/layered-grammar.html">layered grammar of graphics</a>.</p>
<p>A more comprehensive documentation is coming soon.</p>
<p>The current draft was written by Daniel Slutsky, mentored by jsa-aerial (Hanami author) and Kira McLean.</p>
Expand Down
8 changes: 4 additions & 4 deletions docs/search.json

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion notebooks/hanamicloth/walkthrough.clj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
;; ## Setup

;; Here we require Hanamicloth's main API namepace
;; as well as those of Hanami and Tablecloth,
;; as well as those of [Hanami](https://github.com/jsa-aerial/hanami)
;; and [Tablecloth](https://scicloj.github.io/tablecloth/),
;; and also [Kindly](https://scicloj.github.io/kindly-noted/)
;; (which allows us to specify how values should be visualized).

Expand Down Expand Up @@ -39,6 +40,8 @@ mtcars
;; ## Basic usage

;; Let us create a scatter plot from the Iris dataset.
;; We pass a Tablecloth dataset to a Hanamicloth function
;; with a Hanami template.
;; Here we use Hanami's original templates (`ht/chart`)
;; and substitution keys (`:X`, `:Y`, `:MSIZE`).

Expand Down
8 changes: 4 additions & 4 deletions notebooks/index.clj
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
;; # Preface

;; Hanamicloth is a composition of
;; [Hanami](https://github.com/jsa-aerial/hanami) data visualization [templates](https://github.com/jsa-aerial/hanami?tab=readme-ov-file#templates-substitution-keys-and-transformations)
;; and [Tablecloth](https://scicloj.github.io/tablecloth/) datasets.

;; **Source:** [![(GiuHub repo)](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/scicloj/hanamicloth)
;;
;; **Artifact:** [![(Clojars coordinates)](https://img.shields.io/clojars/v/org.scicloj/hanamicloth.svg)](https://clojars.org/org.scicloj/hanamicloth)
;;
;; **Status:** initial draft
;
;; Hanamicloth is a composition of
;; [Hanami](https://github.com/jsa-aerial/hanami) data visualization [templates](https://github.com/jsa-aerial/hanami?tab=readme-ov-file#templates-substitution-keys-and-transformations)
;; and [Tablecloth](https://scicloj.github.io/tablecloth/) datasets.

;; It adds a simplified set of Hanami templates and defaults alongside those of Hanami,
;; as well as a set of template-processing functions
;; inspired by [ggplot2](https://ggplot2.tidyverse.org/)'s
Expand Down

0 comments on commit 71cc59e

Please sign in to comment.