Skip to content

Commit d24a581

Browse files
jihojiho
committed
Updated documentation with latest version of roxygen
1 parent f9304b3 commit d24a581

File tree

6 files changed

+71
-100
lines changed

6 files changed

+71
-100
lines changed

‎man/scale_brewer.Rd

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ scale_colour_brewer(..., type = "seq", palette = 1)
1212

1313
scale_fill_brewer(..., type = "seq", palette = 1)
1414

15-
scale_colour_distiller(..., type = "seq", palette = 1,
16-
values = NULL, space = "Lab", na.value = "grey50")
15+
scale_colour_distiller(..., type = "seq", palette = 1, values = NULL,
16+
space = "Lab", na.value = "grey50")
1717

18-
scale_fill_distiller(..., type = "seq", palette = 1,
19-
values = NULL, space = "Lab", na.value = "grey50")
18+
scale_fill_distiller(..., type = "seq", palette = 1, values = NULL,
19+
space = "Lab", na.value = "grey50")
2020

2121
scale_color_brewer(..., type = "seq", palette = 1)
2222

23-
scale_color_distiller(..., type = "seq", palette = 1,
24-
values = NULL, space = "Lab", na.value = "grey50")
23+
scale_color_distiller(..., type = "seq", palette = 1, values = NULL,
24+
space = "Lab", na.value = "grey50")
2525
}
2626
\arguments{
2727
\item{type}{One of seq (sequential), div (diverging) or
@@ -38,20 +38,18 @@ scale_color_distiller(..., type = "seq", palette = 1,
3838
\item{na.value}{Colour to use for missing values}
3939
}
4040
\description{
41-
Create colour scales based on ColorBrewer colours.
41+
Create colour scales based on ColorBrewer colours.
4242
}
4343
\details{
44-
ColorBrewer provides sequential, diverging and
45-
qualitative colour schemes which are particularly suited
46-
and tested to display discrete values (levels of a
47-
factor) on a map. ggplot2 can use those colours in
48-
discrete scales. It also allows to smoothly interpolate
49-
the colours to a continuous scale, although the original
50-
colour schemes (particularly the qualitative ones) were
51-
not intended for this. The perceptual result is left to
52-
the appreciation of the user.
53-
54-
See \url{http://colorbrewer2.org} for more information.
44+
ColorBrewer provides sequential, diverging and qualitative colour schemes
45+
which are particularly suited and tested to display discrete values (levels
46+
of a factor) on a map. ggplot2 can use those colours in discrete scales. It
47+
also allows to smoothly interpolate the colours to a continuous scale,
48+
although the original colour schemes (particularly the qualitative ones)
49+
were not intended for this. The perceptual result is left to the
50+
appreciation of the user.
51+
52+
See \url{http://colorbrewer2.org} for more information.
5553
}
5654
\examples{
5755
dsamp <- diamonds[sample(nrow(diamonds), 1000), ]

‎man/scale_gradient.Rd

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -98,16 +98,19 @@ qplot(mpg, wt, data = mtcars, colour = miss) +
9898
\code{\link[scales]{seq_gradient_pal}} for details on underlying
9999
palette
100100

101-
Other colour scales: \code{\link{scale_color_brewer}},
102-
\code{\link{scale_color_discrete}},
101+
Other colour scales: \code{\link{scale_color_brewer}},
103102
\code{\link{scale_color_distiller}},
104-
\code{\link{scale_color_gradient2}},
105-
\code{\link{scale_color_gradientn}},
106-
\code{\link{scale_color_grey}},
107-
\code{\link{scale_color_hue}},
108103
\code{\link{scale_colour_brewer}},
109-
\code{\link{scale_colour_discrete}},
110104
\code{\link{scale_colour_distiller}},
105+
\code{\link{scale_fill_brewer}},
106+
\code{\link{scale_fill_distiller}};
107+
\code{\link{scale_color_discrete}},
108+
\code{\link{scale_color_hue}},
109+
\code{\link{scale_colour_discrete}},
110+
\code{\link{scale_colour_hue}},
111+
\code{\link{scale_fill_discrete}},
112+
\code{\link{scale_fill_hue}};
113+
\code{\link{scale_color_gradient2}},
111114
\code{\link{scale_colour_gradient2}},
112115
\code{\link{scale_fill_gradient2}};
113116
\code{\link{scale_color_gradientn}},
@@ -116,13 +119,5 @@ qplot(mpg, wt, data = mtcars, colour = miss) +
116119
\code{\link{scale_color_grey}},
117120
\code{\link{scale_colour_grey}},
118121
\code{\link{scale_fill_grey}}
119-
\code{\link{scale_colour_hue}},
120-
\code{\link{scale_fill_brewer}},
121-
\code{\link{scale_fill_discrete}},
122-
\code{\link{scale_fill_distiller}},
123-
\code{\link{scale_fill_gradient2}},
124-
\code{\link{scale_fill_gradientn}},
125-
\code{\link{scale_fill_grey}},
126-
\code{\link{scale_fill_hue}}
127122
}
128123

‎man/scale_gradient2.Rd

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,34 +86,29 @@ p + scale_fill_gradient2("fill")
8686
}
8787
}
8888
\seealso{
89-
Other colour scales: \code{\link{scale_color_brewer}},
90-
\code{\link{scale_color_continuous}},
91-
\code{\link{scale_color_discrete}},
89+
Other colour scales: \code{\link{scale_color_brewer}},
9290
\code{\link{scale_color_distiller}},
93-
\code{\link{scale_color_gradient}},
94-
\code{\link{scale_color_gradientn}},
95-
\code{\link{scale_color_grey}},
96-
\code{\link{scale_color_hue}},
9791
\code{\link{scale_colour_brewer}},
98-
\code{\link{scale_colour_continuous}},
99-
\code{\link{scale_colour_discrete}},
10092
\code{\link{scale_colour_distiller}},
101-
\code{\link{scale_colour_gradient}},
102-
\code{\link{scale_colour_gradientn}},
103-
\code{\link{scale_colour_grey}},
104-
\code{\link{scale_colour_hue}},
10593
\code{\link{scale_fill_brewer}},
94+
\code{\link{scale_fill_distiller}};
95+
\code{\link{scale_color_continuous}},
96+
\code{\link{scale_color_gradient}},
97+
\code{\link{scale_colour_continuous}},
98+
\code{\link{scale_colour_gradient}},
10699
\code{\link{scale_fill_continuous}},
107100
\code{\link{scale_fill_gradient}};
108101
\code{\link{scale_color_discrete}},
109102
\code{\link{scale_color_hue}},
110103
\code{\link{scale_colour_discrete}},
111104
\code{\link{scale_colour_hue}},
112105
\code{\link{scale_fill_discrete}},
113-
\code{\link{scale_fill_distiller}},
114-
\code{\link{scale_fill_gradient}},
115-
\code{\link{scale_fill_gradientn}},
116-
\code{\link{scale_fill_grey}},
117-
\code{\link{scale_fill_hue}}
106+
\code{\link{scale_fill_hue}};
107+
\code{\link{scale_color_gradientn}},
108+
\code{\link{scale_colour_gradientn}},
109+
\code{\link{scale_fill_gradientn}};
110+
\code{\link{scale_color_grey}},
111+
\code{\link{scale_colour_grey}},
112+
\code{\link{scale_fill_grey}}
118113
}
119114

‎man/scale_gradientn.Rd

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -67,34 +67,29 @@ d + scale_colour_gradientn(colours = terrain.colors(10),
6767
}
6868
}
6969
\seealso{
70-
Other colour scales: \code{\link{scale_color_brewer}},
71-
\code{\link{scale_color_continuous}},
72-
\code{\link{scale_color_discrete}},
70+
Other colour scales: \code{\link{scale_color_brewer}},
7371
\code{\link{scale_color_distiller}},
74-
\code{\link{scale_color_gradient}},
75-
\code{\link{scale_color_gradient2}},
76-
\code{\link{scale_color_grey}},
77-
\code{\link{scale_color_hue}},
7872
\code{\link{scale_colour_brewer}},
79-
\code{\link{scale_colour_continuous}},
80-
\code{\link{scale_colour_discrete}},
8173
\code{\link{scale_colour_distiller}},
82-
\code{\link{scale_colour_gradient}},
83-
\code{\link{scale_colour_gradient2}},
84-
\code{\link{scale_colour_grey}},
85-
\code{\link{scale_colour_hue}},
8674
\code{\link{scale_fill_brewer}},
75+
\code{\link{scale_fill_distiller}};
76+
\code{\link{scale_color_continuous}},
77+
\code{\link{scale_color_gradient}},
78+
\code{\link{scale_colour_continuous}},
79+
\code{\link{scale_colour_gradient}},
8780
\code{\link{scale_fill_continuous}},
8881
\code{\link{scale_fill_gradient}};
8982
\code{\link{scale_color_discrete}},
9083
\code{\link{scale_color_hue}},
9184
\code{\link{scale_colour_discrete}},
9285
\code{\link{scale_colour_hue}},
9386
\code{\link{scale_fill_discrete}},
94-
\code{\link{scale_fill_distiller}},
95-
\code{\link{scale_fill_gradient}},
96-
\code{\link{scale_fill_gradient2}},
97-
\code{\link{scale_fill_grey}},
98-
\code{\link{scale_fill_hue}}
87+
\code{\link{scale_fill_hue}};
88+
\code{\link{scale_color_gradient2}},
89+
\code{\link{scale_colour_gradient2}},
90+
\code{\link{scale_fill_gradient2}};
91+
\code{\link{scale_color_grey}},
92+
\code{\link{scale_colour_grey}},
93+
\code{\link{scale_fill_grey}}
9994
}
10095

‎man/scale_grey.Rd

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,34 +40,29 @@ qplot(mpg, wt, data = mtcars, colour = miss) +
4040
scale_colour_grey(na.value = "green")
4141
}
4242
\seealso{
43-
Other colour scales: \code{\link{scale_color_brewer}},
44-
\code{\link{scale_color_continuous}},
45-
\code{\link{scale_color_discrete}},
43+
Other colour scales: \code{\link{scale_color_brewer}},
4644
\code{\link{scale_color_distiller}},
47-
\code{\link{scale_color_gradient}},
48-
\code{\link{scale_color_gradient2}},
49-
\code{\link{scale_color_gradientn}},
50-
\code{\link{scale_color_hue}},
5145
\code{\link{scale_colour_brewer}},
52-
\code{\link{scale_colour_continuous}},
53-
\code{\link{scale_colour_discrete}},
5446
\code{\link{scale_colour_distiller}},
55-
\code{\link{scale_colour_gradient}},
56-
\code{\link{scale_colour_gradient2}},
57-
\code{\link{scale_colour_gradientn}},
58-
\code{\link{scale_colour_hue}},
5947
\code{\link{scale_fill_brewer}},
48+
\code{\link{scale_fill_distiller}};
49+
\code{\link{scale_color_continuous}},
50+
\code{\link{scale_color_gradient}},
51+
\code{\link{scale_colour_continuous}},
52+
\code{\link{scale_colour_gradient}},
6053
\code{\link{scale_fill_continuous}},
6154
\code{\link{scale_fill_gradient}};
6255
\code{\link{scale_color_discrete}},
6356
\code{\link{scale_color_hue}},
6457
\code{\link{scale_colour_discrete}},
6558
\code{\link{scale_colour_hue}},
6659
\code{\link{scale_fill_discrete}},
67-
\code{\link{scale_fill_distiller}},
68-
\code{\link{scale_fill_gradient}},
69-
\code{\link{scale_fill_gradient2}},
70-
\code{\link{scale_fill_gradientn}},
71-
\code{\link{scale_fill_hue}}
60+
\code{\link{scale_fill_hue}};
61+
\code{\link{scale_color_gradient2}},
62+
\code{\link{scale_colour_gradient2}},
63+
\code{\link{scale_fill_gradient2}};
64+
\code{\link{scale_color_gradientn}},
65+
\code{\link{scale_colour_gradientn}},
66+
\code{\link{scale_fill_gradientn}}
7267
}
7368

‎man/scale_hue.Rd

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,15 @@ qplot(mpg, wt, data = mtcars, colour = miss) +
8585
}
8686
}
8787
\seealso{
88-
Other colour scales: \code{\link{scale_color_brewer}},
89-
\code{\link{scale_color_continuous}},
88+
Other colour scales: \code{\link{scale_color_brewer}},
9089
\code{\link{scale_color_distiller}},
91-
\code{\link{scale_color_gradient}},
92-
\code{\link{scale_color_gradient2}},
93-
\code{\link{scale_color_gradientn}},
94-
\code{\link{scale_color_grey}},
9590
\code{\link{scale_colour_brewer}},
96-
\code{\link{scale_colour_continuous}},
9791
\code{\link{scale_colour_distiller}},
92+
\code{\link{scale_fill_brewer}},
93+
\code{\link{scale_fill_distiller}};
94+
\code{\link{scale_color_continuous}},
95+
\code{\link{scale_color_gradient}},
96+
\code{\link{scale_colour_continuous}},
9897
\code{\link{scale_colour_gradient}},
9998
\code{\link{scale_fill_continuous}},
10099
\code{\link{scale_fill_gradient}};
@@ -106,12 +105,6 @@ qplot(mpg, wt, data = mtcars, colour = miss) +
106105
\code{\link{scale_fill_gradientn}};
107106
\code{\link{scale_color_grey}},
108107
\code{\link{scale_colour_grey}},
109-
\code{\link{scale_fill_brewer}},
110-
\code{\link{scale_fill_continuous}},
111-
\code{\link{scale_fill_distiller}},
112-
\code{\link{scale_fill_gradient}},
113-
\code{\link{scale_fill_gradient2}},
114-
\code{\link{scale_fill_gradientn}},
115108
\code{\link{scale_fill_grey}}
116109
}
117110

0 commit comments

Comments
 (0)