Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update resource section #2415

Merged
merged 11 commits into from
Mar 6, 2023
6 changes: 3 additions & 3 deletions altair/sphinxext/altairgallery.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@
{{ title }}
{% for char in title %}-{% endfor %}

This gallery contains a selection of examples of the plots Altair can create.

Some may seem fairly complicated at first glance, but they are built by combining a simple set of declarative building blocks.
This gallery contains a selection of examples of the plots Altair can create. Some may seem fairly complicated at first glance, but they are built by combining a simple set of declarative building blocks.

Many draw upon sample datasets compiled by the `Vega <https://vega.github.io/vega/>`_ project. To access them yourself, install `vega_datasets <https://github.com/altair-viz/vega_datasets>`_.

.. code-block:: none

$ pip install vega_datasets

If you can't fint the plots you are looking for here, make sure to check out the :ref:`altair-ecosystem` section, which has links to packages for making e.g. network diagrams and animations.

{% for grouper, group in examples %}

.. _gallery-category-{{ grouper }}:
Expand Down
2 changes: 2 additions & 0 deletions doc/getting_started/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,7 @@ handled automatically. Building on this declarative plotting idea, a surprising
of simple to sophisticated plots and visualizations can be created using a relatively
concise grammar.

This documentation serves as the main reference for learning about Altair, and additional learning material and tutorials can be found in the :ref:`learning-resources` section.

.. _Vega: http://vega.github.io/vega
.. _Vega-Lite: http://vega.github.io/vega-lite
155 changes: 125 additions & 30 deletions doc/user_guide/ecosystem.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,127 @@
.. _ecosystem:

Resources & Ecosystem
=====================

We hope to make it easier to find these packages and learning resources by listing them here. If you know of a project that should be added, please let us know.
joelostblom marked this conversation as resolved.
Show resolved Hide resolved

.. _learning-resources:

Learning Resources
------------------

This is a list of a resources that complements the official documentation and can help you learn more about how to use Altair.
joelostblom marked this conversation as resolved.
Show resolved Hide resolved

`Visualization Curriculum`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~

A data visualization curriculum from the UW data group that developed Vega-Lite.

.. List of links.
.. _`Visualization Curriculum`: https://uwdata.github.io/visualization-curriculum

`Jupyter Notebook Tutorials`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Jupyter Notebooks tutorials and examples from the Altair authors.
joelostblom marked this conversation as resolved.
Show resolved Hide resolved

.. List of links.
.. _`Jupyter Notebook Tutorials`: https://github.com/altair-viz/altair_notebooks

`Pycon Tutorial`_
~~~~~~~~~~~~~~~~~

Altair tutorial given at PyCon 2018 by the Altair authors.
joelostblom marked this conversation as resolved.
Show resolved Hide resolved

.. List of links.
.. _`Pycon tutorial`: https://altair-viz.github.io/altair-tutorial

`Data Visualization Course`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This course covers how to create common statistical visualizations, tell stories with data, create geographical visualizations, and bring plots to life by adding interactive elements. Created at the University of British Columbia and can either be audited or taken as part of the `Key Capabilities for Data Science`_ certificate program.

.. List of links.
.. _`Data Visualization Course`: https://viz-learn.mds.ubc.ca
.. _`Key Capabilities for Data Science`: https://extendedlearning.ubc.ca/programs/key-capabilities-data-science

`Brief Introduction Videos`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Calmcode provides a few videos that give a brief overview of the Altair library.

.. List of links.
.. _`Brief Introduction Videos`: https://calmcode.io/altair/introduction.html


.. _altair-ecosystem:

Altair Ecosystem
================
----------------

This is a list of projects directs related to Altair. There are many other packages that can be used in tandem with Altair, e.g. `dashboard packages which you can read more about in the answers to this StackOverflow question`_.
joelostblom marked this conversation as resolved.
Show resolved Hide resolved

.. List of links.
.. _`dashboard packages which you can read more about in the answers to this StackOverflow question`: https://stackoverflow.com/questions/49833866/making-dashboards-using-altair

Vega-Lite_
~~~~~~~~~~

The higher-level visualization grammar that Altair implements in Python.

.. List of links.
.. _Vega-Lite: https://vega.github.io/vega-lite

vl-convert_
~~~~~~~~~~~

This is a list of projects related to or built on top of Altair. We hope to make it easier to find these projects by listing them here. If you know of a project that should be added, please let us know.
Python library for converting Altair/Vega-Lite chart specifications into static images (SVG or PNG) or Vega chart specifications without any external dependencies.

.. List of links.
.. _vl-convert: https://github.com/vega/vl-convert

joelostblom marked this conversation as resolved.
Show resolved Hide resolved
altair_saver_
~~~~~~~~~~~~~

Enables saving charts to a variety of output types.

.. List of links.
.. _altair_saver: https://github.com/altair-viz/altair_saver

altair_data_server_
~~~~~~~~~~~~~~~~~~~

Data transformer plugin that transparently serves data for charts.

.. List of links.
.. _altair_data_server: https://github.com/altair-viz/altair_data_server

altair_pandas_
~~~~~~~~~~~~~~

Altair backend for the pandas plotting API.

.. List of links.
.. _altair_pandas: https://github.com/altair-viz/altair_pandas

vega_datasets_
~~~~~~~~~~~~~~

Offline access to the Vega datasets used in the Altair documentation.

.. List of links.
.. _vega_datasets: https://github.com/altair-viz/vega_datasets

altair_recipes_
---------------
~~~~~~~~~~~~~~~

altair-recipes provides a collection of ready-made statistical graphics for vega. See the `docs <https://altair-recipes.readthedocs.io/en/latest/>`__.
altair_recipes provides a collection of ready-made statistical graphics for Altair. See the `docs <https://altair-recipes.readthedocs.io/en/latest/>`__.

.. List of links.
.. _altair_recipes: https://github.com/piccolbo/altair_recipes

gpdvega_
joelostblom marked this conversation as resolved.
Show resolved Hide resolved
--------
~~~~~~~~

gpdvega is a bridge between GeoPandas_, a geospatial extension of Pandas_, and Altair which allows to seamlessly chart geospatial data using altair. See the `docs <https://iliatimofeev.github.io/gpdvega/>`__.

Expand All @@ -24,46 +131,34 @@ gpdvega is a bridge between GeoPandas_, a geospatial extension of Pandas_, and A
.. _Pandas: https://pandas.pydata.org/

nx_altair_
----------
~~~~~~~~~~

nx_altair is a library for drawing NetworkX_ graphs using Altair. It offers a similar draw API as NetworkX but returns Altair Charts instead. This allows users to apply Altair's rich interactive API to networks graphs. See the `docs <https://github.com/Zsailer/nx_altair/blob/master/examples/nx_altair-tutorial.ipynb>`__.

.. List of links.
.. _nx_altair: https://github.com/Zsailer/nx_altair
.. _NetworkX: https://networkx.github.io/

pdvega_
-------

pdvega is a library that allows you to quickly create interactive Vega-Lite_ plots from Pandas_ dataframes, using an API that is nearly identical to Pandas' built-in visualization tools, and designed for easy use within the Jupyter_ notebook. See the `docs <https://altair-viz.github.io/pdvega/>`__.
`Altair Ally`_
~~~~~~~~~~~~~~

Altair Ally is a companion package to Altair, which provides a few shortcuts to create common plots for exploratory data analysis, particularly those involving visualization of an entire dataframe.

.. List of links.
.. _pdvega: https://github.com/altair-viz/pdvega
.. _Vega-Lite: https://vega.github.io/vega-lite/
.. _Jupyter: http://jupyter.org/
.. _`Altair Ally`: https://joelostblom.github.io/altair_ally

`Altair in R`_
--------------
Altair in R provides an R interface to the Altair Python package. See the `docs <https://vegawidget.github.io/altair/>`__.

.. List of links.
.. _`Altair in R`: https://github.com/vegawidget/altair

starborn_
---------

Starborn is a Python visualization library based on Vega and Altair that aims to be API-compatible with Seaborn_. Like Seaborn, it provides a high-level interface for drawing attractive statistical graphics. Thanks to the underlying libraries, it can also offer interactivity with in-browser panning and zooming. See the `docs <https://github.com/PythonCharmers/starborn/blob/master/doc/starborn_examples.ipynb>`__.
gif_
~~~~

gif is the extension for Altair and matplotlib animations. The library provides a simple, high-level decorator interface to create frames in a regular for-loop that can be stitched together on save. See the `docs <https://github.com/maxhumber/gif>`__.

.. List of links.
.. _starborn: https://github.com/PythonCharmers/starborn
.. _Seaborn: https://seaborn.pydata.org/index.html
.. _gif: https://github.com/maxhumber/gif

gif_
----
`Altair in R`_
~~~~~~~~~~~~~~

gif is the extension for Altair and matplotlib animations. The library provides a simple, high-level decorator interface to create frames in a regular for-loop that can be stitched together on save. See the `docs <https://github.com/maxhumber/gif>`__.
Altair in R provides an R interface to the Altair Python package. See the `docs <https://vegawidget.github.io/altair/>`__.

.. List of links.
.. _gif: https://github.com/maxhumber/gif
.. _`Altair in R`: https://github.com/vegawidget/altair