geom_timeline_label: GeomTimeline_label: 'geom_timeline_label()'
In atibot/eqplot: Visualize the earthquake data

Description Usage Arguments Value Note Examples

This geom and geom_timeline_label function will add annotations to the earthquake data. 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. There should be an 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.

1
2
3

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

`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.
`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`	A Date class date which specifies the minimum timeline range. This is optional. If not specified, the minimum timeline range of the `data` is assumed.
`xmax`	A Date class date which specifies the maximum timeline range. This is optional. If not specified, the maximum timeline range of the `data` is assumed.
`n_max`	A integer to subset to n_max number of earthquakes. This is optional. If not specified, 3 is assumed (default).
`...`	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.

Adds a vertical line to each data point with a text annotation for n_max largest (by magnitude) earthquakes.

This geom_timeline_label function should be added with (+) to the previous geom_timeline() or ggplot2 object generated by geom_timeline() with the same timeline range as the previous geom_timeline(). Unfortunately at this version it is required for users to ensure the coincident of the timeline range.

## Not run: 
ggtimeline + geom_timeline_label(ggplot2::aes(
                                  x = DATE,
                                  y = COUNTRY,
                                  mag = EQ_PRIMARY,
                                  label = LOCATION_NAME),
                                  n_max = 5)

## End(Not run)