diff --git a/man/annotation_ticks.Rd b/man/annotation_ticks.Rd index ab305fb..1d745de 100644 --- a/man/annotation_ticks.Rd +++ b/man/annotation_ticks.Rd @@ -21,13 +21,13 @@ bottom, and left.} using \code{scale_y_log10}. It should be \code{FALSE} when using \code{coord_trans(y = "log10")}.} -\item{short}{a \code{\link[grid]{unit}} object specifying the length of the +\item{short}{a \code{\link[grid:unit]{grid::unit()}} object specifying the length of the short tick marks} -\item{mid}{a \code{\link[grid]{unit}} object specifying the length of the +\item{mid}{a \code{\link[grid:unit]{grid::unit()}} object specifying the length of the middle tick marks. In base 10, these are the "5" ticks.} -\item{long}{a \code{\link[grid]{unit}} object specifying the length of the +\item{long}{a \code{\link[grid:unit]{grid::unit()}} object specifying the length of the long tick marks. In base 10, these are the "1" (or "10") ticks.} \item{colour}{Colour of the tick marks.} diff --git a/man/byte_format.Rd b/man/byte_format.Rd index 03ae699..6033fb8 100644 --- a/man/byte_format.Rd +++ b/man/byte_format.Rd @@ -8,7 +8,7 @@ \alias{bytes} \title{Bytes formatter: convert to byte measurement and display symbol.} \usage{ -byte_format(symbol = "auto", units = "binary") +byte_format(symbol = "auto", units = "binary", only_highest = TRUE) Kb(x) @@ -16,7 +16,7 @@ Mb(x) Gb(x) -bytes(x, symbol = "auto", units = c("binary", "si")) +bytes(x, symbol = "auto", units = c("binary", "si"), only_highest = FALSE) } \arguments{ \item{symbol}{byte symbol to use. If "\code{auto}" the symbol used will be @@ -28,13 +28,16 @@ equivalents and "\code{iB}" equivalents.} \item{units}{which unit base to use, "\code{binary}" (1024 base) or "\code{si}" (1000 base) for ISI units.} +\item{only_highest}{Whether to use the unit of the highest number or +each number uses its own unit.} + \item{x}{a numeric vector to format} } \value{ a function with three parameters, \code{x}, a numeric vector that - returns a character vector, \code{symbol} the byte symbol (e.g. "\code{Kb}") - desired and the measurement \code{units} (traditional \code{binary} or - \code{si} for ISI metric units). + returns a character vector, \code{symbol} a single or a vector of byte +symbol(s) (e.g. "\code{Kb}") desired and the measurement \code{units} +(traditional \code{binary} or \code{si} for ISI metric units). } \description{ Bytes formatter: convert to byte measurement and display symbol. diff --git a/man/geom_bkde.Rd b/man/geom_bkde.Rd index f4d838c..4ba78f9 100644 --- a/man/geom_bkde.Rd +++ b/man/geom_bkde.Rd @@ -15,24 +15,24 @@ stat_bkde(mapping = NULL, data = NULL, geom = "area", na.rm = FALSE, show.legend = NA, inherit.aes = TRUE, ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{position}{Position adjustment, either as a string, or the result of a call to a position adjustment function.} @@ -50,14 +50,16 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} diff --git a/man/geom_bkde2d.Rd b/man/geom_bkde2d.Rd index 5b52856..c5e9575 100644 --- a/man/geom_bkde2d.Rd +++ b/man/geom_bkde2d.Rd @@ -16,24 +16,24 @@ stat_bkde2d(mapping = NULL, data = NULL, geom = "density2d", show.legend = NA, inherit.aes = TRUE, ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{stat}{The statistical transformation to use on the data for this layer, as a string.} @@ -64,14 +64,16 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} diff --git a/man/geom_cartogram.Rd b/man/geom_cartogram.Rd index d9f1869..e016692 100644 --- a/man/geom_cartogram.Rd +++ b/man/geom_cartogram.Rd @@ -8,29 +8,29 @@ geom_cartogram(mapping = NULL, data = NULL, stat = "identity", ..., map, na.rm = FALSE, show.legend = NA, inherit.aes = TRUE) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{stat}{The statistical transformation to use on the data for this layer, as a string.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} @@ -45,12 +45,14 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} } \description{ This replicates the old behaviour of \code{geom_map()}, enabling specifying of diff --git a/man/geom_dumbbell.Rd b/man/geom_dumbbell.Rd index 2a69064..f081c85 100644 --- a/man/geom_dumbbell.Rd +++ b/man/geom_dumbbell.Rd @@ -10,24 +10,24 @@ geom_dumbbell(mapping = NULL, data = NULL, ..., colour_x = NULL, na.rm = FALSE, show.legend = NA, inherit.aes = TRUE) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{...}{other arguments passed on to \code{\link{layer}}. These are often aesthetics, used to set an aesthetic to a fixed value, like @@ -51,12 +51,14 @@ a warning. If \code{TRUE} silently removes missing values.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} } \description{ The dumbbell geom is used to create dumbbell charts. diff --git a/man/geom_horizon.Rd b/man/geom_horizon.Rd index 064679c..ef91175 100644 --- a/man/geom_horizon.Rd +++ b/man/geom_horizon.Rd @@ -7,7 +7,7 @@ \alias{stat_horizon} \alias{StatHorizon} \title{Plot a time series as a horizon plot} -\format{An object of class \code{GeomHorizon} (inherits from \code{GeomArea}, \code{GeomRibbon}, \code{Geom}, \code{ggproto}) of length 4.} +\format{An object of class \code{GeomHorizon} (inherits from \code{GeomArea}, \code{GeomRibbon}, \code{Geom}, \code{ggproto}, \code{gg}) of length 4.} \usage{ geom_horizon(mapping = NULL, data = NULL, show.legend = TRUE, inherit.aes = TRUE, na.rm = TRUE, bandwidth = NULL, ...) diff --git a/man/geom_lollipop.Rd b/man/geom_lollipop.Rd index 6f807da..6cfc9f6 100644 --- a/man/geom_lollipop.Rd +++ b/man/geom_lollipop.Rd @@ -9,24 +9,24 @@ geom_lollipop(mapping = NULL, data = NULL, ..., horizontal = FALSE, show.legend = NA, inherit.aes = TRUE) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{...}{other arguments passed on to \code{\link{layer}}. These are often aesthetics, used to set an aesthetic to a fixed value, like @@ -49,12 +49,14 @@ a warning. If \code{TRUE} silently removes missing values.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} } \description{ The lollipop geom is used to create lollipop charts. diff --git a/man/geom_stateface.Rd b/man/geom_stateface.Rd index 8de91ff..6124d77 100644 --- a/man/geom_stateface.Rd +++ b/man/geom_stateface.Rd @@ -10,24 +10,24 @@ geom_stateface(mapping = NULL, data = NULL, stat = "identity", inherit.aes = TRUE) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{stat}{The statistical transformation to use on the data for this layer, as a string.} @@ -35,7 +35,7 @@ layer, as a string.} \item{position}{Position adjustment, either as a string, or the result of a call to a position adjustment function.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} @@ -55,12 +55,14 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} } \description{ The \code{label} parameter can be either a 2-letter state abbreviation diff --git a/man/geom_ubar.Rd b/man/geom_ubar.Rd index 874f313..d27e481 100644 --- a/man/geom_ubar.Rd +++ b/man/geom_ubar.Rd @@ -9,24 +9,24 @@ geom_ubar(mapping = NULL, data = NULL, stat = "identity", inherit.aes = TRUE) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{stat}{The statistical transformation to use on the data for this layer, as a string.} @@ -44,12 +44,14 @@ a warning. If \code{TRUE} silently removes missing values.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} } \description{ I've been using \code{geom_segment} more to make "bar" charts, setting diff --git a/man/geom_xspline.Rd b/man/geom_xspline.Rd index 5d6fabf..aef2679 100644 --- a/man/geom_xspline.Rd +++ b/man/geom_xspline.Rd @@ -16,24 +16,24 @@ stat_xspline(mapping = NULL, data = NULL, geom = "line", rep_ends = TRUE, ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{position}{Position adjustment, either as a string, or the result of a call to a position adjustment function.} @@ -43,12 +43,14 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} \item{spline_shape}{A numeric vector of values between -1 and 1, which control the shape of the spline relative to the control points.} @@ -60,7 +62,7 @@ closed shape.} first and last control points should be replicated for drawing the curve. Ignored for closed X-splines.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} diff --git a/man/geom_xspline2.Rd b/man/geom_xspline2.Rd index 47b2ef8..b162c23 100644 --- a/man/geom_xspline2.Rd +++ b/man/geom_xspline2.Rd @@ -10,24 +10,24 @@ geom_xspline2(mapping = NULL, data = NULL, stat = "identity", inherit.aes = TRUE, ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{stat}{Use to override the default connection between \code{geom_xspline} and \code{stat_xspline}.} @@ -40,14 +40,16 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} diff --git a/man/stat_ash.Rd b/man/stat_ash.Rd index dff7032..0354cd8 100644 --- a/man/stat_ash.Rd +++ b/man/stat_ash.Rd @@ -9,24 +9,24 @@ stat_ash(mapping = NULL, data = NULL, geom = "area", position = "stack", show.legend = NA, inherit.aes = TRUE, ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{geom}{Use to override the default Geom} @@ -50,14 +50,16 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.} diff --git a/man/stat_stepribbon.Rd b/man/stat_stepribbon.Rd index b3120d6..e679072 100644 --- a/man/stat_stepribbon.Rd +++ b/man/stat_stepribbon.Rd @@ -9,24 +9,24 @@ stat_stepribbon(mapping = NULL, data = NULL, geom = "ribbon", inherit.aes = TRUE, direction = "hv", ...) } \arguments{ -\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or -\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the +\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or +\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the default), it is combined with the default mapping at the top level of the plot. You must supply \code{mapping} if there is no plot mapping.} \item{data}{The data to be displayed in this layer. There are three - options: +options: - If \code{NULL}, the default, the data is inherited from the plot - data as specified in the call to \code{\link{ggplot}}. +If \code{NULL}, the default, the data is inherited from the plot +data as specified in the call to \code{\link[=ggplot]{ggplot()}}. - A \code{data.frame}, or other object, will override the plot - data. All objects will be fortified to produce a data frame. See - \code{\link{fortify}} for which variables will be created. +A \code{data.frame}, or other object, will override the plot +data. All objects will be fortified to produce a data frame. See +\code{\link[=fortify]{fortify()}} for which variables will be created. - A \code{function} will be called with a single argument, - the plot data. The return value must be a \code{data.frame.}, and - will be used as the layer data.} +A \code{function} will be called with a single argument, +the plot data. The return value must be a \code{data.frame.}, and +will be used as the layer data.} \item{geom}{which geom to use; defaults to "\code{ribbon}"} @@ -38,17 +38,19 @@ a warning. If \code{TRUE}, missing values are silently removed.} \item{show.legend}{logical. Should this layer be included in the legends? \code{NA}, the default, includes if any aesthetics are mapped. -\code{FALSE} never includes, and \code{TRUE} always includes.} +\code{FALSE} never includes, and \code{TRUE} always includes. +It can also be a named logical vector to finely select the aesthetics to +display.} \item{inherit.aes}{If \code{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. \code{\link{borders}}.} +the default plot specification, e.g. \code{\link[=borders]{borders()}}.} \item{direction}{\code{hv} for horizontal-veritcal steps, `vh`` for vertical-horizontal steps} -\item{...}{other arguments passed on to \code{\link{layer}}. These are +\item{...}{other arguments passed on to \code{\link[=layer]{layer()}}. These are often aesthetics, used to set an aesthetic to a fixed value, like \code{color = "red"} or \code{size = 3}. They may also be parameters to the paired geom/stat.}