jaredandClaude Opus 4.6
328d9d2fd6
R-CMD-check / R CMD check (push) Successful in 3m37s
Supports "bottom-right" (default), "bottom-left", "top-right", and "top-left". The position controls both horizontal alignment of the logo grob and whether it is placed above or below the plot. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
39 lines
1.3 KiB
R
39 lines
1.3 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/logo.R
|
|
\name{make_logo_grob}
|
|
\alias{make_logo_grob}
|
|
\title{Get a Civilytics Logo grob}
|
|
\usage{
|
|
make_logo_grob(
|
|
type = c("wordmark", "mark"),
|
|
variant = c("light", "dark"),
|
|
position = c("bottom-right", "bottom-left", "top-right", "top-left")
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{type}{Character. `"wordmark"` (default) uses the full wordmark.
|
|
`"mark"` uses the compact C-pulse icon only.}
|
|
|
|
\item{variant}{Character. `"light"` (default) uses the dark logo for light
|
|
backgrounds. `"dark"` uses the reverse (light) logo for dark backgrounds
|
|
(pairs with [theme_civilytics_dark()]).}
|
|
|
|
\item{position}{Character. Corner placement for the logo: `"bottom-right"`
|
|
(default), `"bottom-left"`, `"top-right"`, or `"top-left"`. Controls
|
|
horizontal alignment of the logo grob.}
|
|
}
|
|
\value{
|
|
A ggplot object (class `"gg"`) containing the logo grob.
|
|
}
|
|
\description{
|
|
Returns a ggplot object containing the Civilytics logo as a rasterGrob,
|
|
ready to compose with plots via [add_logo()], [add_logo_ga()], or the
|
|
pipe-friendly [civilytics_logo()].
|
|
}
|
|
\examples{
|
|
logo <- make_logo_grob() # wordmark, light
|
|
logo <- make_logo_grob("mark", "dark") # mark, dark
|
|
logo <- make_logo_grob(position = "bottom-left") # left-aligned
|
|
class(logo) # "gg" "ggplot"
|
|
}
|