Geom_Timeline_Label: Labelling the timeline(s) of the earthquakes

Description Usage Arguments Details Value Note Examples

Description

The 'geom_timeline_label' function labels the timelines generated by the 'geom_timeline' function.

Usage

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

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().

...

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.

x

- The time parameter (as.Date object)

label

- The location names parameter (character)

n_maxVar

- The parameter that represents the magnitude of the earthquakes. This works together with the n_max parameter

n_max

- Earthquakes beneath this value of magnitude will be shown on the map. The parameter of the magnitude needs to be given in n_maxvar parameter.

Details

The 'geom_time_label' function works with ggplot2 and the 'geom_timeline' function. This function visualises the locations of the earthquakes, indicated by a line above each earthquake event.

Value

A geom visualising the locations of each earthquake event, indicated by a line.

Note

warning - A warning appears when the no data is available to plot.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 
library(magrittr)
data <- eq_clean_data(file) %>%
  filter(COUNTRY == c("China", "Usa", "Japan"),
         DATE >= "1999-01-01",
         DATE <= "2012-12-31")
ggplot() +
  geom_timeline(data, aes(x = DATE, y = COUNTRY, size = richterScaleValue, fill = DEATHS)) +
  theme(legend.position = "bottom") +
  geom_timeline_label(data, aes(x=DATE, label = locations, n_maxVar = EQ_PRIMARY, n_max=10)) +
  labs(x = "Date", y = "Country", fill = "# deaths", size = "Richter scale value")

## End(Not run)

jennychungpy/earthquakes documentation built on July 24, 2017, 10:37 a.m.