Skip to content

Commit 2759443

Browse files
committed
Merged upstream/main into website-polish
2 parents f99a92d + ce6896c commit 2759443

78 files changed

Lines changed: 1986 additions & 763 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1480,7 +1480,7 @@ PROJECT [<aesthetic>, ...] TO <coord_type> [SETTING <properties>]
14801480
| Coord Type | Default Aesthetics | Description |
14811481
|------------|-------------------|-------------|
14821482
| `cartesian` | `x`, `y` | Standard x/y Cartesian coordinates |
1483-
| `polar` | `theta`, `radius` | Polar coordinates (for pie charts, rose plots) |
1483+
| `polar` | `angle`, `radius` | Polar coordinates (for pie charts, rose plots) |
14841484

14851485
**Flipping Axes**:
14861486

@@ -1505,7 +1505,7 @@ Note: For axis limits, use `SCALE x FROM [min, max]` or `SCALE y FROM [min, max]
15051505

15061506
**Polar**:
15071507

1508-
- `theta => <aesthetic>` - Which aesthetic maps to angle (defaults to `y`)
1508+
- No special properties (angle/radius aesthetics are used directly)
15091509

15101510
**Important Notes**:
15111511

@@ -1534,10 +1534,10 @@ PROJECT y, x TO cartesian
15341534
-- Custom aesthetic names
15351535
PROJECT myX, myY TO cartesian
15361536

1537-
-- Polar for pie chart (using default theta/radius aesthetics)
1537+
-- Polar for pie chart (using default angle/radius aesthetics)
15381538
PROJECT TO polar
15391539

1540-
-- Polar with y/x aesthetics (y becomes theta, x becomes radius)
1540+
-- Polar with y/x aesthetics (y becomes angle, x becomes radius)
15411541
PROJECT y, x TO polar
15421542

15431543
-- Polar with start angle offset (3 o'clock position)

doc/ggsql.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
<item>xlim</item>
243243
<item>ylim</item>
244244
<item>ratio</item>
245-
<item>theta</item>
245+
<item>angle</item>
246246
<item>clip</item>
247247
</list>
248248

doc/syntax/clause/facet.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This clause behaves much like the `SETTINGS` clause in `DRAW`, in that it allows
3434
* `'y'`: Shared x-axis scale, independent y-axis scale
3535
* `['x', 'y']`: Independent scales for both axes
3636
* `missing`: Determines how layers behave when the faceting column is missing. It can take two values: `'repeat'` (default), and `'null'`. If `'repeat'` is set, then the layer data is repeated in each panel. If `'null'`, then such layers are only displayed if a null panel is shown, as controlled by the facet scale.
37-
* `ncol`/`nrow`: The dimensions of the layout when faceting by a single variable. Only one of these can be given, as the other is derived based on the number of panels to draw. Default is 3 columns when fewer than 6 categories are present, 4 columns when fewer than 12 categories are present and otherwise 5 columns. When the `BY`-clause is used to set a second faceting variable, the `ncol` and `nrow` setting are not allowed.
37+
* `ncol`/`nrow`: The dimensions of the layout when faceting by a single variable (whole number >= 1). Only one of these can be given, as the other is derived based on the number of panels to draw. Default is 3 columns when fewer than 6 categories are present, 4 columns when fewer than 12 categories are present and otherwise 5 columns. When the `BY`-clause is used to set a second faceting variable, the `ncol` and `nrow` setting are not allowed.
3838

3939
### Facet variables as aesthetics
4040
When you apply faceting to a plot you are creating new aesthetics you can control. For 1-dimensional faceting (no `BY` clause) the aesthetic is called `panel` and for 2-dimensional faceting the aesthetics are called `row` and `column`. You can read more about these aesthetics in [their documentation](../scale/aesthetic/Z_faceting.qmd)

doc/syntax/clause/project.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ This clause behaves much like the `SETTINGS` clause in `DRAW`, in that it allows
3232
If you do not provide a `PROJECT` clause then the coordinate system will be picked for you based on the mappings in your query. The logic is as follows
3333

3434
* If `x`, `y` or any of their variants are mapped to, a Cartesian coordinate system is used
35-
* If `theta`, `radius` or any of their variants are mapped to, a polar coordinate system is used
35+
* If `angle`, `radius` or any of their variants are mapped to, a polar coordinate system is used
3636
* If none of the above applies, the plot defaults to a Cartesian coordinate system
37-
* If multiple applies (e.g. mapping to both x and theta) an error is thrown
37+
* If multiple applies (e.g. mapping to both x and angle) an error is thrown

doc/syntax/coord/cartesian.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ assuming they do not try to use a name that is already being used by any facet o
2020

2121
## Settings
2222
* `clip`: Should data be removed if it appears outside the bounds of the coordinate system. Defaults to `true`
23-
* `ratio`: The aspect ratio between the steps on the vertical and horizontal axis. Defaults to `null` (no enforced aspect ratio)
23+
* `ratio`: The aspect ratio between the steps on the vertical and horizontal axis (must be > 0 if specified). Defaults to `null` (no enforced aspect ratio)
2424

2525
## Examples
2626

doc/syntax/coord/polar.qmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,32 @@ The polar coordinate system interprets its primary aesthetic as the angular posi
88
The polar coordinate system has the following default positional aesthetics which will be used if no others have been provided:
99

1010
* **Primary**: `radius` (distance from center)
11-
* **Secondary**: `theta` (angular position)
11+
* **Secondary**: `angle` (angular position)
1212

1313
Users can provide their own aesthetic names if needed. For example, if using `x` and `y` aesthetics:
1414

1515
```ggsql
1616
PROJECT y, x TO polar
1717
```
1818

19-
This maps `y` to radius and `x` to theta (angle). This is useful when converting from a cartesian coordinate system without editing all the mappings.
19+
This maps `y` to radius and `x` to angle. This is useful when converting from a cartesian coordinate system without editing all the mappings.
2020

2121
## Settings
2222
* `clip`: Should data be removed if it appears outside the bounds of the coordinate system. Defaults to `true`
23-
* `start`: The starting angle in degrees for the theta scale. Controls where "0" on the angular axis begins. Defaults to `0` (12 o'clock position).
23+
* `start`: The starting angle in degrees for the theta scale (-360 to 360). Controls where "0" on the angular axis begins. Defaults to `0` (12 o'clock position).
2424
- `0` = 12 o'clock position (top)
2525
- `90` = 3 o'clock position (right)
2626
- `-90` or `270` = 9 o'clock position (left)
2727
- `180` = 6 o'clock position (bottom)
28-
* `end`: The ending angle in degrees for the theta scale. Defaults to `start + 360` (a full circle). Use this with `start` to create partial polar plots like gauge charts or half-circle visualizations.
28+
* `end`: The ending angle in degrees for the theta scale (-360 to 360). Defaults to `start + 360` (a full circle). Use this with `start` to create partial polar plots like gauge charts or half-circle visualizations.
2929
* `inner`: The inner radius as a proportion (0 to 1) of the outer radius. Defaults to `0` (no hole). Setting this creates a donut chart where the inner portion is empty.
3030
- `0` = full pie (no hole)
3131
- `0.3` = donut with 30% hole
3232
- `0.5` = donut with 50% hole
3333

3434
## Examples
3535

36-
### Pie chart using theta/radius aesthetics
36+
### Pie chart using angle/radius aesthetics
3737
```{ggsql}
3838
VISUALISE species AS fill FROM ggsql:penguins
3939
DRAW bar

doc/syntax/layer/position/dodge.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Dodge doesn't have specific requirements to the scale type of the plot, but will
1212
## Settings
1313
Apart from the settings of the layer type, setting `position => 'dodge'` will allow these additional settings:
1414

15-
* `width`: The total width the dodging will occupy as a proportion of the space available on the scale. Defaults to 0.9 but any defaults from the layer will take precedence.
15+
* `width`: The total width the dodging will occupy as a proportion of the space available on the scale (0 to 1). Defaults to 0.9 but any defaults from the layer will take precedence.
1616

1717
## Examples
1818

doc/syntax/layer/position/jitter.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ Jitter requires at least one axis to be discrete as it only jitters along discre
1212
## Settings
1313
Apart from the settings of the layer type, setting `position => 'jitter'` will allow these additional settings:
1414

15-
* `width`: The total width the jittering will occupy as a proportion of the space available on the scale. Defaults to 0.9
15+
* `width`: The total width the jittering will occupy as a proportion of the space available on the scale (0 to 1). Defaults to 0.4
1616
* `dodge`: Should dodging be applied before jittering. The dodging behavior follows the [dodge position](dodge.qmd) behavior? Default to `true`
1717
* `distribution`: Which kind of distribution should the jittering follow? One of:
1818
- `'uniform'` (default): Jittering is sampled from a uniform distribution between `-width/2` and `width/2`
1919
- `'normal'`: Jittering is sampled from a normal distribution with σ as `width/4` resulting in 95% of the points falling inside the given width
2020
- `'density'`: Jittering follows the density distribution within the group so that the jitter occupies the same area as an equivalent [violin plot](../type/violin.qmd) with density remapped to offset
2121
- `'intensity'`: Jittering follows the intensity distribution within the group so that the jitter occupies the same area as an equivalent [violin plot](../type/violin.qmd) with intensity remapped to offset
22-
22+
2323
If `distribution` is either `'density'` or `'intensity'` then one of the axes must be continuous
24-
* `bandwidth`: A numerical value setting the smoothing bandwidth to use for the `'density'` and `'intensity'` distributions. If absent (default), the bandwidth will be computed using Silverman's rule of thumb.
25-
* `adjust`: A numerical value as multiplier for the `bandwidth` setting, with 1 as default.
24+
* `bandwidth`: Smoothing bandwidth for the `'density'` and `'intensity'` distributions (must be > 0). If absent (default), the bandwidth will be computed using Silverman's rule of thumb.
25+
* `adjust`: Multiplier for the `bandwidth` setting (must be > 0). Defaults to 1.
2626

2727
## Examples
2828
When plotting points on a discrete axis they are all placed in the middle

doc/syntax/layer/position/stack.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stack requires a continuous scale with a range mapping (e.g. either `y` + `yend`
1313
Apart from the settings of the layer type, setting `position => 'stack'` will allow these additional settings:
1414

1515
* `center`: Should the full stack be centered around 0. Can be used in conjunction with area layers to create steamgraphs. Default to `false`
16-
* `total`: Sets a total value to which each stack height is normalised. Setting this value leads to 'fill' behaviour. Defaults to `null` (no normalisation)
16+
* `total`: Sets a total value to which each stack height is normalised (must be > 0 if specified). Setting this value leads to 'fill' behaviour. Defaults to `null` (no normalisation)
1717

1818
## Examples
1919

doc/syntax/layer/type/area.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The following aesthetics are recognised by the area layer.
2121
* `linewidth`: The width of the contour lines.
2222

2323
## Settings
24-
* `position`: Determines the position adjustment to use for the layer (default is `'stack'`)
25-
* `orientation`: The orientation of the layer, see the [Orientation section](#orientation). One of the following:
24+
* `position`: Position adjustment. One of `'identity'`, `'stack'` (default), `'dodge'`, or `'jitter'`
25+
* `orientation`: The orientation of the layer, see the [Orientation section](#orientation). One of the following:
2626
* `'aligned'` to align the layer's primary axis with the coordinate system's first axis.
2727
* `'transposed'` to align the layer's primary axis with the coordinate system's second axis.
2828

0 commit comments

Comments
 (0)