geom_timeline_label: Timeline labels of earthquakes

Description Usage Arguments Details Examples

View source: R/geoms.R

Description

This geom plots timeline labels of earthquakes. It assumes that geom_timeline was used to create the timelines

Usage

1
2
3
geom_timeline_label(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", ..., na.rm = FALSE, n_max = 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

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.

Details

The function plots timeline labels of earthquakes based on cleaned NOAA data. It should be used with combination with geom_timeline. The required aesthetics for this geom is label that should contain string for labeling each data point.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
data %>% eq_clean_data() %>%
   filter(COUNTRY %in% c("GREECE", "ITALY"), YEAR > 2000) %>%
   ggplot(aes(x = DATE,
              y = COUNTRY,
              color = as.numeric(TOTAL_DEATHS),
              size = as.numeric(EQ_PRIMARY)
   )) +
   geom_timeline() +
   geom_timeline_label(aes(label = LOCATION_NAME), n_max = 5) +
   theme_timeline() +
   labs(size = "Richter scale value", color = "# deaths")

## End(Not run)

mdelcorvo/earthquaker documentation built on May 21, 2019, 4:01 a.m.