geom_timeline_label: Timeline Labels, for NOAA Earthquake Dataset

Description Usage Arguments Details Note Examples

View source: R/geom_timeline.R

Description

The timeline label geom is used to create lables for the timeline of earthquake data.

Usage

1
2
3
geom_timeline_label(mapping = NULL, data = NULL, stat = "timeline",
  position = "identity", 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

Use to override the default connection between 'geom_timeline' and 'stat_timeline'.

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.

...

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.

Details

The timeline label will add labels to the point data showing the values of the label aesthetic. If the default stat_timeline is used as the stat, N_max aesthetics will subset the labels to the top n based on magnitude.

Note

The NOAA earthquake dataset can be accessed at: NOAA Significant Earthquake Database. This dataset contains information about 5,933 earthquakes around the world over an approximately 4,000 year time span. This package was developed to work with years AC only.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 
ggplot(data=subset(eq_clean_data(sample_eq), !is.na(EQ_PRIMARY) & COUNTRY %in% c("USA","MEXICO")), 
   aes(x = DATE, y = COUNTRY, size = EQ_PRIMARY, xmin = as.Date('2000-01-01',"%Y-%m-%d"), 
   xmax = as.Date('2016-12-31',"%Y-%m-%d"), color = DEATHS, fill = DEATHS, label = LOCATION_NAME)) +
geom_timeline(alpha = .5) +
scale_size_continuous(name = "Richter Scale Value") +
scale_color_continuous(name = "# Deaths") +
scale_fill_continuous(guide=FALSE) +
labs(y = "") +
geom_timeline_label(aes(n_max = 5)) +
theme(legend.position = "bottom",
   legend.key = element_blank(), legend.box = "horizontal", panel.background = element_blank(), 
   axis.line.x = element_line(size = 1, color = "black"), axis.ticks.x = element_line(size = 1))

## End(Not run)

kaquilino/eqvis documentation built on May 17, 2019, 2:44 p.m.