Add an example to each style function

man-roxygen/style_duo.R

@@ -1,3 +1,16 @@
 #' @title Duotone Theme
 #' @description A duotone theme designed to work well with two complementary
 #'   colors.
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_duo(
+#'   primary_color = "#1f4257",
+#'   secondary_color = "#f97b64",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_duo_accent.R

@@ -1,3 +1,16 @@
 #' @title Duotone Accent Theme
 #' @description An default xaringan theme with a two colors used for color
 #'   accents on select elements (headers, bold text, etc.).
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_duo_accent(
+#'   primary_color = "#006747",
+#'   secondary_color = "#cfc493",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_duo_accent_inverse.R

@@ -1,3 +1,16 @@
 #' @title Duotone Accent Inverse Theme
 #' @description An "inverted" default xaringan theme with a two colors used
 #'   for color accents on select elements (headers, bold text, etc.).
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_duo_accent_inverse(
+#'   primary_color = "#006747",
+#'   secondary_color = "#cfc493",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_mono_accent.R

@@ -1,3 +1,15 @@
 #' @title Monotone Accent Theme
 #' @description The default xaringan theme with a single color used for color
 #'   accents on select elements (headers, bold text, etc.).
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_mono_accent(
+#'   base_color = "#43418A",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_mono_accent_inverse.R

@@ -1,3 +1,15 @@
 #' @title Monotone Accent Inverse Theme
 #' @description An "inverted" default xaringan theme with a single color used
 #'   for color accents on select elements (headers, bold text, etc.).
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_mono_accent_inverse(
+#'   base_color = "#3c989e",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_mono_dark.R

@@ -1,2 +1,14 @@
 #' @title Monotone Dark Theme
 #' @description A dark monotone theme based around a single color.
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_mono_dark(
+#'   base_color = "#cbf7ed",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_mono_light.R

@@ -1,2 +1,14 @@
 #' @title Monotone Light Theme
 #' @description A light monotone theme based around a single color.
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_mono_light(
+#'   base_color = "#23395b",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_solarized_dark.R

@@ -3,3 +3,14 @@
 #'   Works well with "\code{highlightStyle: solarized-dark}" or
 #'   "\code{highlighStyle: solarized-light}".
 #' @references \url{http://ethanschoonover.com/solarized}
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_solarized_dark(
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_solarized_light.R

@@ -3,3 +3,14 @@
 #'   Works well with "\code{highlightStyle: solarized-dark}" or
 #'   "\code{highlighStyle: solarized-light}".
 #' @references \url{http://ethanschoonover.com/solarized}
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_solarized_light(
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man-roxygen/style_xaringan.R

@@ -1,2 +1,16 @@
 #' @title Write A Customized Xaringan Theme
 #' @description Creates a customized Xaringan theme CSS file.
+#' @examples
+#' # Create a xaringan style in a temporary file
+#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+#'
+#' style_xaringan(
+#'   text_color = "#002b3",
+#'   inverse_background_color = "#31b09e",
+#'   inverse_text_color = "#002b3",
+#'   outfile = xaringan_themer_css # omit in your slides to write the
+#'                                 # styles to xaringan-themer.css
+#' )
+#'
+#' # View the CSS:
+#' # file.edit(xaringan_themer_css)

man/style_duo.Rd

@@ -378,6 +378,20 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 A duotone theme designed to work well with two complementary
 colors.
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_duo(
+  primary_color = "#1f4257",
+  secondary_color = "#f97b64",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_duo_accent.Rd

@@ -391,6 +391,20 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An default xaringan theme with a two colors used for color
 accents on select elements (headers, bold text, etc.).
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_duo_accent(
+  primary_color = "#006747",
+  secondary_color = "#cfc493",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_duo_accent_inverse.Rd

@@ -393,6 +393,20 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An "inverted" default xaringan theme with a two colors used
 for color accents on select elements (headers, bold text, etc.).
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_duo_accent_inverse(
+  primary_color = "#006747",
+  secondary_color = "#cfc493",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent}()},

man/style_mono_accent.Rd

@@ -380,6 +380,19 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 The default xaringan theme with a single color used for color
 accents on select elements (headers, bold text, etc.).
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_mono_accent(
+  base_color = "#43418A",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_mono_accent_inverse.Rd

@@ -381,6 +381,19 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An "inverted" default xaringan theme with a single color used
 for color accents on select elements (headers, bold text, etc.).
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_mono_accent_inverse(
+  base_color = "#3c989e",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_mono_dark.Rd

@@ -381,6 +381,19 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 A dark monotone theme based around a single color.
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_mono_dark(
+  base_color = "#cbf7ed",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_mono_light.Rd

@@ -381,6 +381,19 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 A light monotone theme based around a single color.
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_mono_light(
+  base_color = "#23395b",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},

man/style_solarized_dark.Rd

@@ -368,6 +368,18 @@ A dark theme based around on the solarized color scheme.
 Works well with "\code{highlightStyle: solarized-dark}" or
 "\code{highlighStyle: solarized-light}".
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_solarized_dark(
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \references{
 \url{http://ethanschoonover.com/solarized}
 }

man/style_solarized_light.Rd

@@ -368,6 +368,18 @@ A light theme based around on the solarized color scheme.
 Works well with "\code{highlightStyle: solarized-dark}" or
 "\code{highlighStyle: solarized-light}".
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_solarized_light(
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \references{
 \url{http://ethanschoonover.com/solarized}
 }

man/style_xaringan.Rd

@@ -366,6 +366,21 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 Creates a customized Xaringan theme CSS file.
 }
+\examples{
+# Create a xaringan style in a temporary file
+xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
+
+style_xaringan(
+  text_color = "#002b3",
+  inverse_background_color = "#31b09e",
+  inverse_text_color = "#002b3",
+  outfile = xaringan_themer_css # omit in your slides to write the
+                                # styles to xaringan-themer.css
+)
+
+# View the CSS:
+# file.edit(xaringan_themer_css)
+}
 \seealso{
 Other themes: 
 \code{\link{style_duo_accent_inverse}()},