Skip to content

Commit 7ce2d1f

Browse files
committed
Update docs
1 parent 7ae2f6c commit 7ce2d1f

File tree

6 files changed

+18
-4
lines changed

6 files changed

+18
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
Data Morph transforms an input dataset of 2D points into select shapes, while preserving the summary statistics to a given number of decimal points through simulated annealing. It is intended to be used as a teaching tool to illustrate the importance of data visualization (see the [Data Morph in the Classroom](https://stefaniemolin.com/data-morph/stable/index.html#classroom-ideas) section for ideas).
7171

7272
<div align="center">
73-
<img alt="Morphing the panda dataset into the star shape." src="https://raw.githubusercontent.com/stefmolin/data-morph/main/docs/_static/panda-to-star-eased.gif">
73+
<img alt="Morphing the panda dataset into the star shape." src="https://stefaniemolin.com/data-morph/stable/_images/panda-to-star-eased.gif">
7474
<br/>
7575
</div>
7676

-353 KB
Loading

docs/_static/panda-to-star.gif

-250 KB
Loading

docs/quickstart.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,24 @@ This produces the following animation in the newly-created ``morphed_data`` dire
4444
within your current working directory:
4545

4646
.. figure:: _static/panda-to-star.gif
47-
:alt: Morphing the panda dataset into the star shape.
47+
:alt: Morphing the panda dataset into the star shape with marginal plots.
4848
:align: center
4949

50-
Morphing the panda :class:`.Dataset` into the star :class:`.Shape`.
50+
Morphing the panda :class:`.Dataset` into the star :class:`.Shape` with marginal plots.
51+
52+
If you don't want the marginal plots (the histograms on the sides), you can use classic mode:
53+
54+
.. code:: console
55+
56+
$ data-morph --start-shape panda --target-shape star --classic
57+
58+
Animations generated in classic mode include only the scatter plot and the summary statistics:
59+
60+
.. figure:: _static/panda-to-star-classic.gif
61+
:alt: Morphing the panda dataset into the star shape using classic mode.
62+
:align: center
63+
64+
Morphing the panda :class:`.Dataset` into the star :class:`.Shape` using classic mode.
5165

5266
You can smooth the transition with the ``--ease`` or ``--ease-in`` and ``--ease-out`` flags.
5367
The ``--freeze`` flag allows you to start the animation with the specified number of frames

docs/tutorials/custom-datasets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Pass the path to the CSV file to use those points as the starting shape:
9999

100100
.. code:: console
101101
102-
$ data-morph --start-shape path/to/points.csv --target-shape wide_lines
102+
$ data-morph --start-shape path/to/points.csv --target-shape wide_lines --classic
103103
104104
Here is an example animation generated from a custom dataset:
105105

0 commit comments

Comments
 (0)