jared
82b8db7f84
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
37 lines
1.1 KiB
R
37 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/logo.R
|
|
\name{add_logo_ga}
|
|
\alias{add_logo_ga}
|
|
\title{Add a logo to a ggplot2 object}
|
|
\usage{
|
|
add_logo_ga(plot_list, logo, nrow = 1, widths = NULL, margin_param = NULL)
|
|
}
|
|
\arguments{
|
|
\item{plot_list}{a list containing ggplot2 objects}
|
|
|
|
\item{logo}{a grob containing the logo created with `make_logo_grob`}
|
|
|
|
\item{nrow}{an integer, default = 1, for the number of rows to align the plots in}
|
|
|
|
\item{widths}{an optional vector the same length as plot_list with the widths for each plot}
|
|
|
|
\item{margin_param}{a number giving the adjustment up or down to help manually align logo and captions}
|
|
}
|
|
\value{
|
|
a grid object
|
|
}
|
|
\description{
|
|
Add a logo to a ggplot2 object
|
|
}
|
|
\note{
|
|
The resulting object needs to be drawn to the screen using grid.draw()
|
|
}
|
|
\examples{
|
|
library(ggplot2); library(grid)
|
|
tmp_plot <- ggplot(mtcars) + aes(x = hp, y = disp) + geom_point() + theme_civilytics()
|
|
tmp_logo <- make_logo_grob()
|
|
plot_and_logo <- add_logo(tmp_plot, tmp_logo)
|
|
grid.draw(plot_and_logo)
|
|
dev.off()
|
|
}
|