geom_timeline_label: This is the wrapper to the layer function for the...
In JJNewkirk/NOAAEQ: Visualize NOAA EQ data

Description Usage Arguments Details Note

The wrapper is just to plot the object. See ggplot2 package documenation for more specifics on geom_* and layer_* functions.

geom_timeline_label(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", xmindate = lubridate::make_date(-6000, 1, 1),
  xmaxdate = lubridate::make_date(6000, 1, 1), n_max = 3, ...,
  na.rm = TRUE, show.legend = NA, inherit.aes = TRUE)

`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.
`xmindate`	This is a date that will filter data prior to plotting. No EQ prior to this parameter will be plotted.
`xmaxdate`	This is a date that will filter data prior to plotting. No EQ after this parameter will be plotted.
`n_max`	This parameter controls how many EQ are labeled per timeline.
`...`	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.
`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`.

#' @param n_max This aesthetic will limit the number of labels on the graph, ordered by the magnitude in the EQ_PRIMARY field.

linelen This is the length of lines originating at th desired points.

orderby This is the data used to rank the data so that we can select the top n_max. It will sort largest to smallest to select.

x This aesthetic should be a date field as this is mean to be a timeline.

y This aesthetic is used to group EQ in some fashion. For example, y could be set to a country which would subsequently plot each COuntries EQ on a separate line.

label This aesthetic is the data column corresponding to the desired label for each point.

JJNewkirk/NOAAEQ documentation built on May 27, 2019, 1:12 p.m.