geom_timeline: geom_timeline

In nandinigntr/MSDR: Mastering Software Development in R

Description

This method acts behind de scenes creating a layer to plot the output of GeomTimeline function.

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. 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.
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().
...	Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.

Value

Creates a layer to plot the GeomTimeline output function. Updates the graphic inserting new content/visuals.

Examples

## Not run: 
## Full example of geom_timeline using eq_clean_data function to load the raw data and clean it.

# Loading and cleaning. Later subsetting the data.
df_earth <- eq_clean_data(file_name = 'inst/extdata/signif.txt') %>%
    dplyr::filter(YEAR > 2010,
                  COUNTRY %in% c("CHINA","JAPAN")) %>%
                       dplyr::select(DATE,
                       COUNTRY,
                       EQ_PRIMARY,
                       TOTAL_DEATHS,
                       LOCATION) %>%

    ggplot2::ggplot() +
        geom_timeline(aes(x = DATE,
                          y = COUNTRY,
                          size = EQ_PRIMARY,
                          color = TOTAL_DEATHS))
## End(Not run)

nandinigntr/MSDR documentation built on Jan. 1, 2021, 11:32 a.m.