stat_timeline_label: Timeline Label Stat

In thechibo/earthquakes: A Handy Package For Earthquake Datasets

Description

This stat is used in conjuction with the timeline_label geom. It filters the requested dates and countries, as well as keeps the n_max earthquakes with the highest magnitude, before passing the data to geom_timeline().

Usage

stat_timeline_label(
  mapping = NULL,
  data = NULL,
  geom = "timeline_label",
  position = "identity",
  show.legend = NA,
  inherit.aes = TRUE,
  na.rm = FALSE,
  xmin = -Inf,
  xmax = +Inf,
  n_max = NULL,
  ...
)

Arguments

mapping	Set of aesthetic mappings created by aes() or aes_(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.
data	The data to be displayed in this layer. There are three options: If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot(). A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created. A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).
geom	Use to override the default connection with geom_timeline()
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
show.legend	logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.
inherit.aes	If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
xmin	Date: The minimum date to be concluded in the plot
xmax	Date: The maximum date to be concluded in the plot
n_max	Numeric: The number of the earthquakes with the highest magnitude, whose labels will be shown in the plot.
...	Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.

Examples

## Not run: # Read the data
load("data/data.rda")
# Subset the data for plotting examples
data2<-data %>%
 filter(COUNTRY %in% c("USA", "CHINA"))
ggplot(data2) +
stat_timeline_label(geom="timeline_label")
## End(Not run)

thechibo/earthquakes documentation built on April 15, 2020, 4:56 p.m.