Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
piermorel committed Jul 3, 2024
1 parent d9bdcbb commit ae9a322
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Gramm has been used in many publications from varied fields, but is particularil

## Workflow

The typical workflow to generate a figure is detailed in the ["Getting Started" live script.](#demo-live-scripts)
The typical workflow to generate this figure with only 7 lines of code is detailed in the ["Getting Started" live script.](#demo-live-scripts). The figure uses data from the <code>carbig</code> dataset and represents the evolution of fuel economy of new cars with time, depending on the number of cylinders indicated by color, and regions of origin separated across subplot columns.

In short:
<img src="images/gettingstarted_export.png" alt="GettingStarted example" width="800">

In short, the workflow is the following:
1. Provide gramm with the relevant data for the figure: X and Y variables, but also grouping variables that will determine color, subplot rows/columns, etc.
2. Add graphical layers to your figure: raw data layers (directly plot data as points, lines...) or statistical layers (fits, histograms, densities, summaries with confidence intervals...). One instruction is enough to add each layer, and all layers offer many customization options.
3. Draw the figure, gramm takes care of all the annoying parts: no need to loop over colors or subplots, colors and legends are generated automatically, axes limits are taken care of, etc.

For example, with gramm, 7 lines of code are enough to create the figure below from the <code>carbig</code> dataset. Here the figure represents the evolution of fuel economy of new cars in time, with number of cylinders indicated by color, and regions of origin separated across subplot columns:
<img src="images/gettingstarted_export.png" alt="GettingStarted example" width="800">

```matlab
load example_data.mat %Load example dataset about cars
Expand Down

0 comments on commit ae9a322

Please sign in to comment.