Skip to content

Types vignette: list tinyplot types in neater table format #340

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.

Sign up for GitHub

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

Merged
grantmcdermott merged 5 commits into from
Mar 17, 2025
Merged

Types vignette: list tinyplot types in neater table format #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a266792
list extra types in neater table format
grantmcdermott Mar 16, 2025
90140ed
fix paths
grantmcdermott Mar 17, 2025
16678ab
add points and lines
grantmcdermott Mar 17, 2025
b847ace
typo
grantmcdermott Mar 17, 2025
fabe1fe
typo
grantmcdermott Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions vignettes/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
table th {
font-weight: normal;
font-style: italic;
}
91 changes: 53 additions & 38 deletions vignettes/types.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
title: "Plot types"
format:
html:
css: custom.css
tbl-colwidths: [20,20,50,10]
---

**tinyplot** is a lightweight extension of R's base plotting system, designed to
Expand Down Expand Up @@ -54,44 +58,55 @@ advanced visualizations. Each of these additional types are available either as
a convenience string (with default behaviour) or a companion `type_*()` function
(with options for customized behaviour).

Shapes:

- `"area"` / `type_area()`: Plots the area under the curve from `y` = 0 to `y` = f(`x`).
- `"errorbar"` / `type_errorbar()`: Adds error bars to points; requires `ymin` and `ymax`.
- `"pointrange"` / `type_pointrange()`: Combines points with error bars.
- `"polygon"` / `type_polygon()`: Draws polygons.
- `"polypath"` / `type_polypath()`: Draws a path whose vertices are given in `x` and `y`.
- `"rect"` / `type_rect()`: Draws rectangles; requires `xmin`, `xmax`, `ymin`, and `ymax`.
- `"ribbon"` / `type_ribbon()`: Creates a filled area between `ymin` and `ymax`.
- `"segments"` / `type_segments()`: Draws line segments between pairs of points.
- `"text"` / `type_text()`: Add text annotations to a plot.

Visualizations:

- `"barplot"` / `type_barplot()`: Creates a plot plot.
- `"boxplot"` / `type_boxplot()`: Creates a box-and-whisker plot.
- `"density"` / `type_density()`: Plots the density estimate of a variable.
- `"histogram"` / `type_histogram()`: Creates a histogram of a single variable.
- `"jitter"` / `type_jitter()`: Jittered points.
- `"qq"` / `type_qq()`: Creates a quantile-quantile plot.
- `"ridge"` / `type_ridge()`: Creates a ridgeline (aka joy) plot.
- `"rug"` / `type_rug()`: Adds a rug to an existing plot.
- `"spineplot"` / `type_spineplot()`: Creates a spineplot or spinogram.

Models:

- `"loess"` / `type_loess()`: Local regression curve.
- `"lm"` / `type_lm()`: Linear regression line.
- `"glm"` / `type_glm()`: Generalized linear model fit.
- `"spline"` / `type_spline()`: Cubic (or Hermite) spline interpolation.

Functions:

- `type_abline()`: line(s) with intercept and slope.
- `type_hline()`: horizontal line(s).
- `type_vline()`: vertical line(s).
- `type_function()`: arbitrary function.
- `type_summary()`: summarize `y` by unique values of `x`.
#### Shapes

| string | function | description | docs |
|-----------------------|---------------------|----------------------------------------------------------------|------|
| `"area"` | `type_area()` | Plots the area under the curve from `y` = 0 to `y` = f(`x`). | [link](/man/type_ribbon.qmd) |
| `"errorbar"` | `type_errorbar()` | Adds error bars to points; requires `ymin` and `ymax`. | [link](/man/type_errorbar.qmd) |
| `"l"` / `"b"` / etc. | `type_lines()` | Draws lines and line-alike (same as base `"l"`, `"b"`, etc.) | [link](/man/type_lines.qmd) |
| `"pointrange"` | `type_pointrange()` | Combines points with error bars. | [link](/man/type_errorbar.qmd) |
| `"p"` | `type_points()` | Draws points (same as base `"p"`). | [link](/man/type_points.qmd) |
| `"polygon"` | `type_polygon()` | Draws polygons. | [link](/man/type_polygon.qmd) |
| `"polypath"` | `type_polypath()` | Draws a path whose vertices are given in `x` and `y`. | [link](/man/type_polypath.qmd) |
| `"rect"` | `type_rect()` | Draws rectangles; requires `xmin`, `xmax`, `ymin`, and `ymax`. | [link](/man/type_rect.qmd) |
| `"ribbon"` | `type_ribbon()` | Creates a filled area between `ymin` and `ymax`. | [link](/man/type_ribbon.qmd) |
| `"segments"` | `type_segments()` | Draws line segments between pairs of points. | [link](/man/type_segments.qmd) |
| `"text"` | `type_text()` | Adds text annotations to a plot. | [link](/man/type_text.qmd) |

#### Visualizations

| string | function | description | docs |
|----------------------------|---------------------|------------------------------------------------|------|
| `"barplot"` / `"bar"` | `type_barplot()` | Creates a bar plot. | [link](/man/type_barplot.qmd) |
| `"boxplot"` / `"box"` | `type_boxplot()` | Creates a box-and-whisker plot. | [link](/man/type_boxplot.qmd) |
| `"density"` | `type_density()` | Plots the density estimate of a variable. | [link](/man/type_density.qmd) |
| `"histogram"` / `"hist"` | `type_histogram()` | Creates a histogram of a single variable. | [link](/man/type_histogram.qmd) |
| `"jitter"` / `"j"` | `type_jitter()` | Jittered points. | [link](/man/type_jitter.qmd) |
| `"qq"` | `type_qq()` | Creates a quantile-quantile plot. | [link](/man/type_qq.qmd) |
| `"ridge"` | `type_ridge()` | Creates a ridgeline (aka joy) plot. | [link](/man/type_ridge.qmd) |
| `"rug"` | `type_rug()` | Adds a rug to an existing plot. | [link](/man/type_rug.qmd) |
| `"spineplot"` / `"spine"` | `type_spineplot()` | Creates a spine plot or spinogram. | [link](/man/type_spineplot.qmd) |

#### Models

| string | function | description | docs |
|-----------------------|--------------------|------------------------------------------|------|
| `"loess"` | `type_loess()` | Local regression curve. | [link](/man/type_loess.qmd) |
| `"lm"` | `type_lm()` | Linear regression line. | [link](/man/type_lm.qmd) |
| `"glm"` | `type_glm()` | Generalized linear model fit. | [link](/man/type_glm.qmd) |
| `"spline"` | `type_spline()` | Cubic (or Hermite) spline interpolation. | [link](/man/type_spline.qmd) |

#### Functions

| string | function | description | docs |
|-----------------------|--------------------|-----------------------------------------|------|
| _(None)_ | `type_abline()` | Line(s) with intercept and slope. | [link](/man/type_abline.qmd) |
| _(None)_ | `type_hline()` | Horizontal line(s). | [link](/man/type_hline.qmd) |
| _(None)_ | `type_vline()` | Vertical line(s). | [link](/man/type_vline.qmd) |
| _(None)_ | `type_function()` | Arbitrary function. | [link](/man/type_function.qmd) |
| _(None)_ | `type_summary()` | Summarizes `y` by unique values of `x`. | [link](/man/type_summary.qmd) |


To see the difference between the convenience strings and their respective
`type_*()` functional equivalents, let's quickly walk through two examples.
Expand Down