Skip to content

Commit 17822b5

Browse files
committed
Update coord documentation
1 parent ffbe496 commit 17822b5

Some content is hidden

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

46 files changed

+186
-199
lines changed

R/coord-.r

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,23 @@
1313
#' - `render_bg`: Renders background elements.
1414
#' - `render_axis_h`: Renders the horizontal axes.
1515
#' - `render_axis_v`: Renders the vertical axes.
16-
#' - `range`: Returns the x and y ranges
16+
#' - `backtransform_range(panel_params)`: Extracts the panel range provided
17+
#' in `panel_params` (created by `setup_panel_params()`, see below) and
18+
#' backtransforms to data coordinates. This back-transformation is needed
19+
#' for coords such as `coord_flip()`, `coord_polar()`, `coord_trans()` where
20+
#' the range in the transformed coordinates differs from the range in the
21+
#' untransformed coordinates.
22+
#' - `range`: Deprecated, do not implement. Calls `backtransform_range()`.
1723
#' - `transform`: Transforms x and y coordinates.
1824
#' - `distance`: Calculates distance.
1925
#' - `is_linear`: Returns `TRUE` if the coordinate system is
2026
#' linear; `FALSE` otherwise.
2127
#' - `is_free`: Returns `TRUE` if the coordinate system supports free
22-
#' positional scales.
23-
#' - `setup_panel_params(data)`:
28+
#' positional scales; `FALSE` otherwise.
29+
#' - `setup_panel_params(scale_x, scale_y, params)`: Determines the appropriate
30+
#' x and y ranges for each panel, and also calculates anything else needed to
31+
#' render the panel and axes, such as tick positions and labels for major
32+
#' and minor ticks. Returns all this information in a named list.
2433
#' - `setup_data(data, params)`: Allows the coordinate system to
2534
#' manipulate the plot data. Should return list of data frames.
2635
#' - `setup_layout(layout, params)`: Allows the coordinate

man/annotation_logticks.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/borders.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/continuous_scale.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/coord_map.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/coord_trans.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cut_interval.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/discrete_scale.Rd

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/element.Rd

Lines changed: 6 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/facet_grid.Rd

Lines changed: 3 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/fortify.sp.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_abline.Rd

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_bar.Rd

Lines changed: 3 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_bin2d.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_boxplot.Rd

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_contour.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_density.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_density_2d.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_hex.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_histogram.Rd

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_jitter.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_qq.Rd

Lines changed: 2 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_quantile.Rd

Lines changed: 3 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_segment.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_smooth.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_text.Rd

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_violin.Rd

Lines changed: 4 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)