geom_timeline_label: A labeler geom for the geom_timeline

In RedTent/earthquakeJT: Process and visualize NOAA Earthquake Data - Mastering Software Development in R Capstone

Description

This geom creates labels to annotate the timeline(s) created by the geom_timeline.

Usage

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

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.
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
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().
n_max	optional, a number to label only those earthquakes with the largest magnitudes. An aesthetic magnitude must be provided.
...	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.

Value

Returns a layer that can be added to a ggplot object.

Aesthetics

geom_timeline understands the following aesthetics :

• x, required, should be a date

• label, required, the text to display

• y, the same as in geom_timeline

• magnitude, should be provided when n_max is used

Examples

## Not run: 

data <- get_eq_data() %>% eq_clean_data() %>% eq_location_clean()

ggplot(data, aes(x = date)) + geom_timeline() + geom_timeline_label(aes(label = LOCATION))

ggplot(data, aes(x = date)) +
    geom_timeline() +
    geom_timeline_label(aes(label = LOCATION, magnitude = EQ_PRIMARY), n_max = 5)

## End(Not run)

RedTent/earthquakeJT documentation built on May 25, 2019, 1:25 p.m.