geom_timeline_label: This geom adds a vertical line to each data point with a text...

Description Usage Arguments Examples

Description

This geom adds a vertical line to each data point with a text annotation (e.g. the location of the earthquake) attached to each line with option to subset to n_max number of earthquakes, where we take the n_max largest (by magnitude) earthquakes. Aesthetics are x, which is the date of the earthquake and label which takes the column name from which annotations will be obtained.

Usage

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

Arguments

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.

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.

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.

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

Minimum X Axis limit, Start date year

xmax

Maximum X Axis limit, End date year

n_max

Number of Label to plot

...

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.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
 ggplot(
  data = merged_date_data,
  aes(
    x = DATE,
    y = COUNTRY,
    colour = merged_date_data$TOTAL_DEATHS,
    size = merged_date_data$EQ_PRIMARY,
    date = merged_date_data$DATE,
    countries = merged_date_data$COUNTRY,
    location_name = merged_date_data$LOCATION_NAME
  )
) +
  geom_timeLine(xmin = START_DATE,
                xmax = END_DATE) +

## End(Not run)

garvish/earthquakes documentation built on May 16, 2019, 5:41 p.m.