geom_timeline: Actual function that draw the earthquake timeline

In learner42/CourseraRcapstone: Project for the Coursera's R Programming Capstone Course

Description

Actual function that draw the earthquake timeline

Usage

geom_timeline(mapping = NULL, data = NULL, stat = "identity",
  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	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.
...	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

In a typical use case, the user should specify the DATE as the x aesthetic, a grouping, e.g country for y, and 2 other measurements for color and size, e.g. TOTAL_DEATHS and EQ_PRIMARY (earthquake maginitude).

Examples

## Not run: 
    read_eq_clean_data() %>%
      dplyr::filter(YEAR > 2000 & !IS_BC & COUNTRY %in% c("USA", "CANADA")) %>%
      dplyr::mutate(TOTAL_DEATHS = as.numeric(TOTAL_DEATHS),
                    EQ_PRIMARY = as.numeric(EQ_PRIMARY)) %>%
      ggplot2::ggplot(ggplot2::aes(x = DATE,
                                   y = COUNTRY,
                                   color = TOTAL_DEATHS,
                                   size = EQ_PRIMARY
                                   )) +
      geom_timeline()

## End(Not run)

learner42/CourseraRcapstone documentation built on May 30, 2019, 4:37 p.m.