geom_timeline_label: geom_timeline_label

In Darwinita/EarthquakingLCP: Functions to process and analyze data from NOAA

Description

A geom for labelling earthquake timeline plots created using geom_timeline.

Usage

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

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.
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.
xmin	(optional): minimum date for earthquakes
xmax	(optional): maximum date for earthquakes
n_max	An integer corresponding to the number of top earthquakes to label, sorted by measure of magnitude.
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
...	Additional arguments

Details

geom_timeline_label adds a vertical line to each earthquake data point with a text label (e.g. LOCATION_NAME). There should be an option to subset to n_max number of earthquakes,sorted by any measure of magnitude (e.g. EQ_PRIMARY).

Value

A ggplot2 graphical object with labelled geom_timeline plots.

Aesthetics for geom_timeline, with the required ones indicated in bold

• x: DATE

• label: LOCATION_NAME or any labels to be added

• y: COUNTRY or another factor for stratification

• measure: EQ_PRIMARY or any other measure of magnitude to be passed

• color

• fill

• size

• alpha

References

https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1

Examples

## Not run: 
xmin = lubridate::ymd_hm("1016-01-01",truncated = 2)
xmax = lubridate::ymd_hm("2016-01-01",truncated = 2)
NOAAdf <- eq_clean_data("signif.txt")
NOAAdfSp <- NOAAdf %>%
  dplyr::filter(COUNTRY %in% c("SPAIN", "IRAN", "BELGIUM"))
ggplot2::ggplot(data = NOAAdfSp, ggplot2::aes(x = DATE,
                            y = COUNTRY,
)) +
  geom_timeline(ggplot2::aes(size = EQ_PRIMARY,
                    fill = TOTAL_DEATHS),
                xmin = xmin, xmax = xmax) +
  geom_timeline_label(aes(label = LOCATION_NAME, measure = EQ_PRIMARY),
                      xmin = xmin, xmax = xmax, n_max = 5) +
  theme_timeline() +
  ggplot2::labs(size = "Richter scale value", fill = "# deaths")

## End(Not run)

Darwinita/EarthquakingLCP documentation built on May 12, 2019, 8:40 a.m.