coord_S4: Cartesian coordinates for S4 classes

Description Usage Arguments Details Value Examples

View source: R/coord_constructors.R

Description

The Cartesian coordinate system is the typical linear coordinate system wherein a point on the plane is parameterised by the x- and y-position and distances between point are Euclidean. The S4 variant allows the contextual evaluation of, for example, ranged data classes.

Usage

1
coord_S4(xlim = NULL, ylim = NULL, expand = TRUE, default = FALSE, clip = "on")

Arguments

xlim

Limits for the x and y axes.

ylim

Limits for the x and y axes.

expand

If TRUE, the default, adds a small expansion factor to the limits to ensure that data and axes don't overlap. If FALSE, limits are taken exactly from the data or xlim/ylim.

default

Is this the default coordinate system? If FALSE (the default), then replacing this coordinate system with another one creates a message alerting the user that the coordinate system is being replaced. If TRUE, that warning is suppressed.

clip

Should drawing be clipped to the extent of the plot panel? A setting of "on" (the default) means yes, and a setting of "off" means no. In most cases, the default of "on" should not be changed, as setting clip = "off" can cause unexpected results. It allows drawing of data points anywhere on the plot, including in the plot margins. If limits are set via xlim and ylim and some data points fall outside those limits, then those data points may show up in places such as the axes, the legend, the plot title, or the plot margins.

Details

This coordinate function is designed to work with S4 scales. In absence thereof, no contextual evaluation should occur.

As a temporary workaround, when the coordinates are set up, all S4 Vector classes are disguised as the WoodenHorse class.

Value

A Coord ggproto object.

Examples

1

teunbrand/ggnomics documentation built on Aug. 2, 2020, 7:34 p.m.