use_logo: Use a package logo

In usethis: Automate Package and Project Setup

Use a package logo

Description

This function helps you use a logo in your package:

• Enforces a specific size

• Stores logo image file at man/figures/logo.png

• Produces the markdown text you need in README to include the logo

Usage

use_logo(img, geometry = "240x278", retina = TRUE)

Arguments

img	The path to an existing image file
geometry	a magick::geometry string specifying size. The default assumes that you have a hex logo using spec from http://hexb.in/sticker.html.
retina	TRUE, the default, scales the image on the README, assuming that geometry is double the desired size.

Examples

## Not run: 
use_logo("usethis.png")

## End(Not run)

usethis documentation built on Sept. 11, 2024, 5:29 p.m.