geom_timeline_label: Create labels for a timeline diagram

In RMHoek/NOAAearthquakeAnalysis: Data analysis of Significant Earthquake Data from the NOAA

Description

This geom creates labels for a timeline plot using dates (requires x aesthetics), and the label text (requires label aesthetics) with optional maximal number of labels (depending on optional n_max aesthetics) of the largest events by size param in geom_timeline.

Usage

geom_timeline_label(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", ..., na.rm = FALSE, n_max = NULL, xmin = NULL,
  xmax = NULL, show.legend = NA, inherit.aes = TRUE)

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.
stat	The statistical transformation to use on the data for this layer, as a string.
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
...	other arguments passed on to layer. These are often aesthetics, used to set an aesthetic to a fixed value, like color = "red" or size = 3. They may also be parameters to the paired geom/stat.
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
n_max	An integer. If used, it only plots the labels for the n_max largest earthquakes in the selected group in the timeline
xmin	A date. If used the plot will start from this date
xmax	A date. If used the plot will end at this date
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.
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.

Value

Grob representing labels for timeline(s) with datapoints

Note

required_aes x, label with x the date of data points plotted and label the variable containing the label text

Examples

## Not run: 
eq_data %>% eq_clean_data() %>%
   filter(COUNTRY %in% c("GREECE", "ITALY"), year(DATE) > 2000) %>%
   ggplot(aes(x = DATE,
                  y = COUNTRY,
                  color = TOTAL_DEATHS,
                  size = EQ_PRIMARY)) +
   geom_timeline() +
   geom_timeline_label(aes(label = LOCATION), n_max = 8) +
   theme_timeline() +
   scale_size(name = "Richter scale", limits = c(5, 8)) +
   scale_color_gradient(name = "# Deaths", low = "black", high = "blue")

## End(Not run)

RMHoek/NOAAearthquakeAnalysis documentation built on May 14, 2019, 8:58 a.m.