chore: add example plot graphic to manual pages

hrbrmstr · Apr 12, 2023 · ba0e62a · ba0e62a
1 parent 96ed7a5
commit ba0e62a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/R/ggsolar-package.R b/R/ggsolar-package.R
@@ -2,6 +2,13 @@
 #'
 #' Generate "solar system" plots using everyone's favorite plotting package.
 #'
+#' \if{html}{
+#'   \out{<div style="text-align: center">}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{</div>}
+#' }
+#' \if{latex}{
+#'   \out{\begin{center}}\figure{README-sol-1.png}\out{\end{center}}
+#' }
+#'
 #' @md
 #' @name ggsolar
 #' @keywords internal

diff --git a/R/plot-orbits.R b/R/plot-orbits.R
@@ -14,6 +14,13 @@
 #' at a minimum — a polygon geom and point geom. A text geom can
 #' optionally be added, but only naive positioning of labels is performed.
 #'
+#' \if{html}{
+#'   \out{<div style="text-align: center">}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{</div>}
+#' }
+#' \if{latex}{
+#'   \out{\begin{center}}\figure{README-sol-1.png}\out{\end{center}}
+#' }
+#'
 #' @param orbits (df)
 #' @param planet_positions (df)
 #' @param label_planets (bool) if `TRUE`, then planet labels will be

diff --git a/man/ggsolar.Rd b/man/ggsolar.Rd
diff --git a/man/plot_orbits.Rd b/man/plot_orbits.Rd