Skip to content

Commit 3f7fceb

Browse files
committed
Link the documentation of all themes
Using the `@family` keyword of roxygen
1 parent 456c9fd commit 3f7fceb

File tree

7 files changed

+41
-0
lines changed

7 files changed

+41
-0
lines changed

R/theme-defaults.r

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#' @param base_family base font family
55
#' @aliases theme_gray theme_grey
66
#' @export theme_gray theme_grey
7+
#' @family themes
78
theme_grey <- function(base_size = 12, base_family = "") {
89
theme(
910
# Elements in this first block aren't used directly, but are inherited
@@ -66,6 +67,7 @@ theme_gray <- theme_grey
6667
#' @param base_size base font size
6768
#' @param base_family base font family
6869
#' @export
70+
#' @family themes
6971
theme_bw <- function(base_size = 12, base_family = "") {
7072
# Starts with theme_grey and then modify some parts
7173
theme_grey(base_size = base_size, base_family = base_family) %+replace%
@@ -87,6 +89,7 @@ theme_bw <- function(base_size = 12, base_family = "") {
8789
#' @param base_size base font size
8890
#' @param base_family base font family
8991
#' @export
92+
#' @family themes
9093
theme_linedraw <- function(base_size = 12, base_family = "") {
9194
# Starts with theme_grey and then modify some parts
9295
theme_grey(base_size = base_size, base_family = base_family) %+replace%
@@ -109,6 +112,7 @@ theme_linedraw <- function(base_size = 12, base_family = "") {
109112
#' @param base_size base font size
110113
#' @param base_family base font family
111114
#' @export
115+
#' @family themes
112116
theme_light <- function(base_size = 12, base_family = "") {
113117
# Starts with theme_grey and then modify some parts
114118
theme_grey(base_size = base_size, base_family = base_family) %+replace%
@@ -131,6 +135,7 @@ theme_light <- function(base_size = 12, base_family = "") {
131135
#' @param base_size base font size
132136
#' @param base_family base font family
133137
#' @export
138+
#' @family themes
134139
theme_minimal <- function(base_size = 12, base_family = "") {
135140
# Starts with theme_bw and then modify some parts
136141
theme_bw(base_size = base_size, base_family = base_family) %+replace%
@@ -149,6 +154,7 @@ theme_minimal <- function(base_size = 12, base_family = "") {
149154
#' @param base_size base font size
150155
#' @param base_family base font family
151156
#' @export
157+
#' @family themes
152158
theme_classic <- function(base_size = 12, base_family = ""){
153159
theme_bw(base_size = base_size, base_family = base_family) %+replace%
154160
theme(

man/theme_bw.Rd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ theme_bw(base_size = 12, base_family = "")
1313
\description{
1414
A theme with white background and dark gridlines.
1515
}
16+
\seealso{
17+
Other themes: \code{\link{theme_classic}};
18+
\code{\link{theme_gray}}, \code{\link{theme_grey}};
19+
\code{\link{theme_light}}; \code{\link{theme_linedraw}};
20+
\code{\link{theme_minimal}}
21+
}
1622

man/theme_classic.Rd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ theme_classic(base_size = 12, base_family = "")
1313
\description{
1414
A classic-looking theme, with x and y axis lines and no gridlines.
1515
}
16+
\seealso{
17+
Other themes: \code{\link{theme_bw}};
18+
\code{\link{theme_gray}}, \code{\link{theme_grey}};
19+
\code{\link{theme_light}}; \code{\link{theme_linedraw}};
20+
\code{\link{theme_minimal}}
21+
}
1622

man/theme_grey.Rd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,9 @@ theme_grey(base_size = 12, base_family = "")
1414
\description{
1515
A theme with grey background and white gridlines.
1616
}
17+
\seealso{
18+
Other themes: \code{\link{theme_bw}};
19+
\code{\link{theme_classic}}; \code{\link{theme_light}};
20+
\code{\link{theme_linedraw}}; \code{\link{theme_minimal}}
21+
}
1722

man/theme_light.Rd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ theme_light(base_size = 12, base_family = "")
1313
\description{
1414
A theme with white background and light grey lines
1515
}
16+
\seealso{
17+
Other themes: \code{\link{theme_bw}};
18+
\code{\link{theme_classic}}; \code{\link{theme_gray}},
19+
\code{\link{theme_grey}}; \code{\link{theme_linedraw}};
20+
\code{\link{theme_minimal}}
21+
}
1622

man/theme_linedraw.Rd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ theme_linedraw(base_size = 12, base_family = "")
1313
\description{
1414
A theme with white background and black gridlines.
1515
}
16+
\seealso{
17+
Other themes: \code{\link{theme_bw}};
18+
\code{\link{theme_classic}}; \code{\link{theme_gray}},
19+
\code{\link{theme_grey}}; \code{\link{theme_light}};
20+
\code{\link{theme_minimal}}
21+
}
1622

man/theme_minimal.Rd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ theme_minimal(base_size = 12, base_family = "")
1313
\description{
1414
A minimalistic theme with no background annotations.
1515
}
16+
\seealso{
17+
Other themes: \code{\link{theme_bw}};
18+
\code{\link{theme_classic}}; \code{\link{theme_gray}},
19+
\code{\link{theme_grey}}; \code{\link{theme_light}};
20+
\code{\link{theme_linedraw}}
21+
}
1622

0 commit comments

Comments
 (0)