Skip to content

Commit d0bf588

Browse files
wchwch
committed
Re-document with roxygen2 4.1.0
1 parent 704d423 commit d0bf588

File tree

197 files changed

+777
-581
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

197 files changed

+777
-581
lines changed

‎NAMESPACE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Generated by roxygen2 (4.0.0): do not edit by hand
1+
# Generated by roxygen2 (4.1.0): do not edit by hand
22

33
S3method("+",gg)
44
S3method("[",uneval)

‎man/absoluteGrob.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/grob-absolute.r
23
\name{absoluteGrob}
34
\alias{absoluteGrob}
45
\title{Absolute grob}

‎man/add_theme.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme.r
23
\name{add_theme}
34
\alias{add_theme}
45
\title{Modify properties of an element in a theme object}

‎man/aes.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes.r
23
\name{aes}
34
\alias{aes}
45
\title{Generate aesthetic mappings that describe how variables in the data are

‎man/aes_all.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes.r
23
\name{aes_all}
34
\alias{aes_all}
45
\title{Given a character vector, create a set of identity mappings}

‎man/aes_auto.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes.r
23
\name{aes_auto}
34
\alias{aes_auto}
45
\title{Automatic aesthetic mapping}

‎man/aes_colour_fill_alpha.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes-colour-fill-alpha.r
23
\name{aes_colour_fill_alpha}
34
\alias{aes_colour_fill_alpha}
45
\alias{alpha}

‎man/aes_group_order.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes-group-order.r
23
\name{aes_group_order}
34
\alias{aes_group_order}
45
\alias{group}

‎man/aes_linetype_size_shape.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes-linetype-size-shape.r
23
\name{aes_linetype_size_shape}
34
\alias{aes_linetype_size_shape}
45
\alias{linetype}

‎man/aes_position.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes-position.r
23
\name{aes_position}
34
\alias{aes_position}
45
\alias{x}

‎man/aes_string.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/aes.r
23
\name{aes_string}
34
\alias{aes_q}
45
\alias{aes_string}

‎man/annotate.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/annotation.r
23
\name{annotate}
34
\alias{annotate}
45
\title{Create an annotation layer.}

‎man/annotation_custom.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/annotation-custom.r
23
\name{annotation_custom}
34
\alias{annotation_custom}
45
\title{Annotation: Custom grob.}

‎man/annotation_logticks.Rd

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/annotation-logticks.r
23
\name{annotation_logticks}
34
\alias{annotation_logticks}
45
\title{Annotation: log tick marks}
@@ -15,6 +16,11 @@ annotation_logticks(base = 10, sides = "bl", scaled = TRUE,
1516
It can be set to a string containing any of \code{"trbl"}, for top, right,
1617
bottom, and left.}
1718

19+
\item{scaled}{is the data already log-scaled? This should be \code{TRUE}
20+
(default) when the data is already transformed with \code{log10()} or when
21+
using \code{scale_y_log10}. It should be \code{FALSE} when using
22+
\code{coord_trans(y = "log10")}.}
23+
1824
\item{short}{a \code{unit} object specifying the length of the short tick marks}
1925

2026
\item{mid}{a \code{unit} object specifying the length of the middle tick marks.
@@ -23,11 +29,6 @@ In base 10, these are the "5" ticks.}
2329
\item{long}{a \code{unit} object specifying the length of the long tick marks.
2430
In base 10, these are the "1" (or "10") ticks.}
2531

26-
\item{scaled}{is the data already log-scaled? This should be \code{TRUE}
27-
(default) when the data is already transformed with \code{log10()} or when
28-
using \code{scale_y_log10}. It should be \code{FALSE} when using
29-
\code{coord_trans(y = "log10")}.}
30-
3132
\item{colour}{Colour of the tick marks.}
3233

3334
\item{size}{Thickness of tick marks, in mm.}

‎man/annotation_map.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/annotation-map.r
23
\name{annotation_map}
34
\alias{annotation_map}
45
\title{Annotation: maps.}

‎man/annotation_raster.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/annotation-raster.r
23
\name{annotation_raster}
34
\alias{annotation_raster}
45
\title{Annotation: High-performance rectangular tiling.}

‎man/autoplot.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/autoplot.r
23
\name{autoplot}
34
\alias{autoplot}
45
\title{Create a complete ggplot appropriate to a particular data type}

‎man/benchplot.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/bench.r
23
\name{benchplot}
34
\alias{benchplot}
45
\title{Benchmark plot creation time.

‎man/borders.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/fortify-map.r
23
\name{borders}
34
\alias{borders}
45
\title{Create a layer of map borders.}

‎man/calc_element.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme.r
23
\name{calc_element}
34
\alias{calc_element}
45
\title{Calculate the element properties, by inheriting properties from its parents}

‎man/continuous_scale.Rd

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/scale-.r
23
\name{continuous_scale}
34
\alias{continuous_scale}
45
\title{Continuous scale constructor.}
@@ -10,18 +11,6 @@ continuous_scale(aesthetics, scale_name, palette, name = NULL,
1011
guide = "legend")
1112
}
1213
\arguments{
13-
\item{minor_breaks}{Used with date or datetime scales. Either \code{NULL} for
14-
no minor breaks, \code{waiver()} for the default breaks (one minor break
15-
between each major break), a numeric vector of positions, or a function
16-
that given the limits returns a vector of minor breaks.}
17-
18-
\item{limits}{A numeric vector of length two describing the scale limits.}
19-
20-
\item{rescaler}{Used by diverging and n colour gradients
21-
(i.e. \code{\link{scale_colour_gradient2}}, \code{\link{scale_colour_gradientn}}).}
22-
23-
\item{oob}{What to do with values outside scale limits (out of bounds)?}
24-
2514
\item{aesthetics}{the names of the aesthetics that this scale works with}
2615

2716
\item{scale_name}{the name of the scale}
@@ -47,13 +36,25 @@ types of input:
4736
This parameter does not affect in any way how the data is scaled - it
4837
only affects the appearance of the legend.}
4938
39+
\item{minor_breaks}{Used with date or datetime scales. Either \code{NULL} for
40+
no minor breaks, \code{waiver()} for the default breaks (one minor break
41+
between each major break), a numeric vector of positions, or a function
42+
that given the limits returns a vector of minor breaks.}
43+
5044
\item{labels}{\code{NULL} for no labels, \code{waiver()} for default
5145
labels (labels the same as breaks), a character vector the same length
5246
as breaks, or a named character vector whose names are used to match
5347
replacement the labels for matching breaks.}
5448
5549
\item{legend}{deprecated. Use \code{guide} instead.}
5650
51+
\item{limits}{A numeric vector of length two describing the scale limits.}
52+
53+
\item{rescaler}{Used by diverging and n colour gradients
54+
(i.e. \code{\link{scale_colour_gradient2}}, \code{\link{scale_colour_gradientn}}).}
55+
56+
\item{oob}{What to do with values outside scale limits (out of bounds)?}
57+
5758
\item{expand}{a numeric vector of length two, giving a multiplicative and
5859
additive constant used to expand the range of the scales so that there
5960
is a small gap between the data and the axes.}

‎man/coord.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-.r
23
\name{coord}
34
\alias{coord}
45
\title{New coordinate system.}

‎man/coord_cartesian.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-cartesian-.r
23
\name{coord_cartesian}
34
\alias{coord_cartesian}
45
\title{Cartesian coordinates.}

‎man/coord_expand_defaults.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-.r
23
\name{coord_expand_defaults}
34
\alias{coord_expand_defaults}
45
\title{Set the default expand values for the scale, if NA}

‎man/coord_fixed.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-fixed.r
23
\name{coord_fixed}
34
\alias{coord_equal}
45
\alias{coord_fixed}

‎man/coord_flip.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-flip.r
23
\name{coord_flip}
34
\alias{coord_flip}
45
\title{Flipped cartesian coordinates.}

‎man/coord_map.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-map.r
23
\name{coord_map}
34
\alias{coord_map}
45
\title{Map projections.}

‎man/coord_polar.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-polar.r
23
\name{coord_polar}
34
\alias{coord_polar}
45
\title{Polar coordinates.}

‎man/coord_quickmap.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-quickmap.R
23
\name{coord_quickmap}
34
\alias{coord_quickmap}
45
\title{Cartesian coordinates with an aspect ratio approximating Mercator projection.}

‎man/coord_trans.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/coord-transform.r
23
\name{coord_trans}
34
\alias{coord_trans}
45
\title{Transformed cartesian coordinate system.}

‎man/cut_interval.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/utilities-break.r
23
\name{cut_interval}
34
\alias{cut_interval}
45
\title{Cut numeric vector into intervals of equal length.}

‎man/cut_number.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/utilities-break.r
23
\name{cut_number}
34
\alias{cut_number}
45
\title{Cut numeric vector into intervals containing equal number of points.}

‎man/cweave.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/utilities-matrix.r
23
\name{cweave}
34
\alias{cweave}
45
\title{Col weave}

‎man/diamonds.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/ggplot2.r
23
\docType{data}
34
\name{diamonds}
45
\alias{diamonds}

‎man/discrete_scale.Rd

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/scale-.r
23
\name{discrete_scale}
34
\alias{discrete_scale}
45
\title{Discrete scale constructor.}
@@ -19,9 +20,6 @@ they should take}
1920
\item{name}{the name of the scale - used as the axis label or the legend
2021
title}
2122

22-
\item{drop}{drop unused factor levels from the scale (\code{TRUE} or
23-
\code{FALSE})}
24-
2523
\item{breaks}{control the breaks in the guide. There are four possible
2624
types of input:
2725
\itemize{
@@ -36,22 +34,25 @@ types of input:
3634
This parameter does not affect in any way how the data is scaled - it
3735
only affects the appearance of the legend.}
3836
39-
\item{limits}{A character vector specifying the data range for the scale.
40-
and the default order of their display in guides.}
41-
4237
\item{labels}{\code{NULL} for no labels, \code{waiver()} for default
4338
labels (labels the same as breaks), a character vector the same length
4439
as breaks, or a named character vector whose names are used to match
4540
replacement the labels for matching breaks.}
4641
4742
\item{legend}{deprecated. Use \code{guide} instead.}
4843
44+
\item{limits}{A character vector specifying the data range for the scale.
45+
and the default order of their display in guides.}
46+
4947
\item{expand}{a numeric vector of length two, giving a multiplicative and
5048
additive constant used to expand the range of the scales so that there
5149
is a small gap between the data and the axes.}
5250
5351
\item{na.value}{how should missing values be displayed?}
5452
53+
\item{drop}{drop unused factor levels from the scale (\code{TRUE} or
54+
\code{FALSE})}
55+
5556
\item{guide}{the name of, or actual function, used to create the
5657
guide.}
5758
}

‎man/economics.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/ggplot2.r
23
\docType{data}
34
\name{economics}
45
\alias{economics}

‎man/element_blank.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme-elements.r
23
\name{element_blank}
34
\alias{element_blank}
45
\title{Theme element: blank.

‎man/element_line.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme-elements.r
23
\name{element_line}
34
\alias{element_line}
45
\title{Theme element: line.}

‎man/element_rect.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme-elements.r
23
\name{element_rect}
34
\alias{element_rect}
45
\title{Theme element: rectangle.}

‎man/element_text.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/theme-elements.r
23
\name{element_text}
34
\alias{element_text}
45
\title{Theme element: text.}

‎man/expand_limits.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.0): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/limits.r
23
\name{expand_limits}
34
\alias{expand_limits}
45
\title{Expand the plot limits with data.}

0 commit comments

Comments
 (0)