geom_timeline: Displays points in a horizontal timeline

Description Usage Arguments Details Value Aesthetics References See Also Examples

Description

geom_timeline is a clone of ggplot2 geom_point that can be used to display points from the NOAA earthquake dataset. The 'x' aesthetic is displayed as data points (see supported optional aesthetics below) and the 'optional y' aesthetic can be used to show multiple timelines, for example by selected countries, in a chart.

Usage

1
2
3
geom_timeline(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", xmin = NA, xmax = NA, ..., 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

xmin

minimum year to use in the diaplay. If no value for xmin is passed, no filtring is done within the geom for lower x value dates. If xmin is passed, data rows with x dates below 1 January in xmin year will be filtered out of the display.

xmax

maximum year to use in the diaplay. If no value for xmax is passed, no filtring is done within the geom for higher x value dates. If xmax is passed, data rows with x dates above 31 December in xmax year will be filtered out of the display.

...

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.

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

Details

GeomTimeline is the ggproto environment object to enable geom_timeline

Value

a ggplot object that can be combined with ggplot or ggmap - this object behaves somewhat like a geom_point ggplot object

Aesthetics

geom_timeline understands the following aesthetics (required aesthetics are in bold):

where x is a vector of type date

the following aesthetics are optional:

References

for more information on ggplot see http://ggplot2.org/ and http://ggplot2.tidyverse.org/

See Also

geom_timeline to plot the points and eq_clean_data to prepare the NOAA data

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
my_clean_df %>%
  filter(COUNTRY %in% c("GREECE", "FRANCE", "JAPAN")) %>%
  ggplot(aes(x=DATE, y=COUNTRY, colour=EQ_PRIMARY, alpha=TOTAL_DEATHS,
         size=EQ_PRIMARY, label=LOCATION_NAME)) +
  geom_timeline(xmin=-200) +
  guides(alpha = FALSE, colour=FALSE) +
  scale_x_date(date_labels = "%Y")

## End(Not run)

jrwalker-projects/quaker documentation built on May 23, 2019, 7:33 a.m.