make_wallpapr: Make Calendar Background

In JBGruber/wallpapr: Create calender wallpapers for your desktop and phone from R

Make Calendar Background

Description

Make Calendar Background

Usage

make_wallpapr(
  img,
  filename,
  month = Sys.Date(),
  resolution = "auto",
  position = "center",
  scale = c("width", "height"),
  colour = "white",
  fill = "grey",
  family = "",
  text_size = 9,
  headline_factor = 2,
  start_monday = TRUE,
  return_plot = FALSE,
  locale = NULL
)

Arguments

img	character. Location of a background image.
filename	character. File name of the output.
month	either a date or name of a month in the current locale.
resolution	"auto" to use the resolution of the input image or vector of length two with width and height of the output image.
position	position of calendar in the image. Possible values are: "center", "bottom", "top", "right", "left", "bottomright", "bottomleft", "topright", "topleft" and a numeric vector of length 4 .
scale	if resolution is provided, should the image be scaled down/up before cropping to the provided resolution?
colour	colour of the font.
fill	a colour to fill the background.
family	font.
text_size	size of the text in the image.
headline_factor	the factor by which the name of the month is larger then the remaining text (2 means twice the size).
start_monday	If TRUE the week starts on Monday, otherwise starts on Sunday.
return_plot	Instead of saving to a file, return a ggplot2 plot object.
locale	provide locale if you want to use non English names for months and days.

Value

saves image in file location

Examples

## Not run: 
make_calendar_background(
  system.file("extdata", "mull.jpg", package = "wallpapr")
)

# put dates in upper right corner
make_calendar_background(
  system.file("extdata", "zima.png", package = "wallpapr"),
  position = c(2, 0, 2, 0)
)

## End(Not run)

JBGruber/wallpapr documentation built on Oct. 7, 2022, 1:32 p.m.