geom_timeline: Geom for creating a timeline from earthquake data

In leskin/earthquaketools: Earthquake Visualization Tools Package for the NOAA Significant Earthquake Database

Description

This function creates a new geom which will create a linear timeline for a specified time range, and will display each earthquake as a point on the timeline.

Usage

geom_timeline(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE, x = NULL, y = NULL, xmindate = NULL,
  xmaxdate = NULL, ...)

Arguments

mapping	A set of aesthetic mappings created by aes or aes_. If specified and inherit.aes = TRUE (the default), it is combined with the default mappint 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 mremoved with a warning. If TRUE, missing values are silently removed.
show.legend	logical. Should this layer be included in the legends? NA, the default, incldes 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 usefule for helper functions that define both data and aesthetics and shouldn't inherit behavior from the default plot specification, e.t. borders.
x	Date of the earthquake (required)
y	Factor indicating some striatification in which case multiple time lines will be ploted for each level of the factor (e.g. country).
xmindate	Minimum year to display on the timeline
xmaxdate	Maximum year to display on the timeline
...	Other arguments passed on layer. Thes 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.

Details

This geom makes use of the GeomEarthquake ggproto object, inherits from the basic Geom. The GeomEarthquake object defines default values for the optional aesthetics color, size, and alpha. A null ggproto opject is created if there are no earthquakes in the desired time range.

This geom is based on (but does not inherit from) the point geom (geom_point). Many of the input parameters are the same as for the geom_point. Parameter descriptions for identical parameters are taken from the geom_point help file to minimize confusion.

A new ggproto object (GeomEarthquake) is created for this geom. The ggproto object inherits from the basic Geom. Default values are provided for the aesthetics size, linetype and alpha. A null ggproto opject is created if there are no earthquakes in the desired time range.

This code is based on input from the Extending ggplot2 vignette: https://cran.r-project.org/web/packages/ggplot2/vignettes/extending-ggplot2.html

Value

This function has no return value

Examples

## Not run: geom_timeline(data = earthquakes_clean,
                       aes(x = DATE, y = COUNTRY,
                       colour = TOTAL_DEATHS, size = EQ_PRIMARY), alpha = 0.6,
                       xmindate = 2000, xmaxdate = 2017)
## End(Not run)

leskin/earthquaketools documentation built on May 12, 2019, 2:02 p.m.