geom_timeline_label: Time line labels of earthquakes

In MuhammadEzzatHBK/MuhammadEzzatHBK-noaa: My Submission

Description

geom_timeline_label return a layer representing earthquakes annotations to be added after geom_timeline, i.e. a vertical line to each data point drown by geom_timeline with a text annotation (e.g. the location of the earthquake) attached to each earthquake line.

Usage

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

GeomTimelineLabel

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. A function can be created from a formula (e.g. ~ head(.x, 10)).
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. 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().
n_max	(int) number of earthquakes, where we take the n_max largest (in size, if provided) earthquakes
...	further arguments passed to the geom layer
na.rm	(lgl) remove missing data?

Format

An object of class GeomTimelineLabel (inherits from Geom, ggproto, gg) of length 6.

Details

Aesthetics: geom_timeline_label understands the following aesthetics (required in bold):

• x: (Date) of earthquakes.

• label: (chr) text annotation.

• y: (factr) stratification. If present multiple time lines will be plotted for each level of the factor (e.g. country).

• colour: of the points.

• n_max: annotation to drowm.

• size: of the points (if provided with n_max too, the n_max largest eartquakes will be annotated).

Examples

## Not run: 
ggplot(noaa,aes(x=DATE,y=COUNTRY,col=TOTAL_DEATHS,size=EQ_PRIMARY))+
geom_timeline_label()+theme_minimal()

## End(Not run)

MuhammadEzzatHBK/MuhammadEzzatHBK-noaa documentation built on March 28, 2020, 12:04 a.m.