diff --git a/R/ggsolar-package.R b/R/ggsolar-package.R index c77b0d9..c5a4117 100644 --- 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{
}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{
} +#' } +#' \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 index 58d1286..9fe20a3 100644 --- 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{
}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{
} +#' } +#' \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 index c28fd15..cc62ed9 100644 --- a/man/ggsolar.Rd +++ b/man/ggsolar.Rd @@ -8,6 +8,14 @@ \description{ Generate "solar system" plots using everyone's favorite plotting package. } +\details{ +\if{html}{ + \out{
}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{
} +} +\if{latex}{ + \out{\begin{center}}\figure{README-sol-1.png}\out{\end{center}} +} +} \seealso{ Useful links: \itemize{ diff --git a/man/plot_orbits.Rd b/man/plot_orbits.Rd index c5042f6..bb6e458 100644 --- a/man/plot_orbits.Rd +++ b/man/plot_orbits.Rd @@ -54,6 +54,13 @@ data frame of planet positions, theoretically generated by \code{\link[=randomize_planet_positions]{randomize_planet_positions()}}, return a ggplot2 skeleton with — 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{
}\figure{README-sol-1.png}{options: style="width:750px;max-width:75\%;"}\out{
} +} +\if{latex}{ + \out{\begin{center}}\figure{README-sol-1.png}\out{\end{center}} +} } \examples{ sol_orbits <- generate_orbits(sol_planets)