Package 'rogtemplate'

Create a GitHub Action that deploys a pkgdown site

Description

Create a GitHub Action workflow that builds a pkgdown site from your package and deploys it to the gh-pages branch.

Usage

rog_actions_pkgdown_branch(pkg = ".", overwrite = TRUE)

Arguments

pkg	Path to package.
overwrite	Overwrite the workflow if it already exists.

Value

The function is called for its side effects and returns invisible(NULL).

See Also

rog_build().

site setup helpers: rog_add_template_pkgdown(), rog_build()

---

Configure rogtemplate for your pkgdown site

Description

Add the rOpenGov template configuration to your ⁠_pkgdown.yml⁠. If no configuration file exists, create one at ⁠pkgdown/_pkgdown.yml⁠. Also add the corresponding paths to .Rbuildignore.

Usage

rog_add_template_pkgdown()

Details

The function also adds these package URLs to ⁠_pkgdown.yml⁠ and DESCRIPTION if they are not already present:

• https://ropengov.github.io/pkgname/

• https://github.com/rOpenGov/pkgname

Value

The function is called for its side effects and returns invisible(NULL).

See Also

pkgdown vignettes: vignette("pkgdown", package = "pkgdown") and vignette("linking", package = "pkgdown"), usethis's usethis::use_tidy_description().

site setup helpers: rog_actions_pkgdown_branch(), rog_build()

Examples

## Not run: 
rog_add_template_pkgdown()

## End(Not run)

---

Add an rOpenGov badge to your README

Description

Add an rOpenGov badge pointing to https://ropengov.org/ to your README:

Usage

rog_badge_ropengov(install = TRUE)

Arguments

install

TRUE or FALSE. If TRUE, the badge is installed on your README.md or README.Rmd. If FALSE, a message with the R Markdown code is displayed.

Details

Value

The function is called for its side effects and returns NULL invisibly.

See Also

usethis's usethis::use_badge().

package asset helpers: rog_load_font(), rog_logo()

Examples

rog_badge_ropengov(install = FALSE)

---

Build your pkgdown site locally

Description

A wrapper around pkgdown's pkgdown::build_site().

Usage

rog_build(pkg = ".", ...)

Arguments

pkg	Path to package.
...	Arguments passed to rog_logo() and pkgdown's pkgdown::build_site(). Common arguments for rog_logo() include overwrite, favicons, p_x, p_y and p_size.

Details

This function also calls rog_add_template_pkgdown() and rog_logo().

Value

The function is called for its side effects and returns invisible(NULL).

See Also

pkgdown's pkgdown::build_site() and rog_add_template_pkgdown().

site setup helpers: rog_actions_pkgdown_branch(), rog_add_template_pkgdown()

---

Load rogtemplate fonts

Description

Load the current rOpenGov font, B612 Mono.

Usage

rog_load_font()

Value

The font family name, "B612 Mono".

See Also

package asset helpers: rog_badge_ropengov(), rog_logo()

Examples

rog_load_font()

---

Create a logo for your rOpenGov package

Description

Creates a logo automatically with hexSticker's hexSticker::sticker(). Optionally, create favicons with pkgdown's pkgdown::build_favicons().

Usage

rog_logo(
  pkgname,
  filename = "man/figures/logo.png",
  p_x = 1,
  p_y = 1,
  p_size = 202.6 * nchar(pkgname)^-1.008,
  overwrite = FALSE,
  favicons = TRUE
)

Arguments

pkgname	Name of the package. If not supplied, the name is detected from DESCRIPTION.
filename	filename to save sticker
p_x	x position for package name
p_y	y position for package name
p_size	font size for package name
overwrite	Should the current logo be overwritten? When TRUE it runs usethis's usethis::use_logo().
favicons	Should favicons be created with pkgdown's pkgdown::build_favicons()?

Value

The function is called for its side effects and returns NULL invisibly.

See Also

hexSticker's hexSticker::sticker(), usethis's usethis::use_logo() and pkgdown's pkgdown::build_favicons().

package asset helpers: rog_badge_ropengov(), rog_load_font()

Examples

tmp <- tempfile(fileext = ".png")
rog_logo("test a package", tmp, overwrite = FALSE, favicons = FALSE)

# Display the logo.
logo <- magick::image_read(tmp)

logo

plot(logo)

---

rOpenGov color palettes

Description

Color palettes based on the rOpenGov color scheme.

Usage

rog_orange_pal(n = 4, alpha = 0.9, rev = FALSE)

rog_dark_pal(n = 4, alpha = 0.9, rev = FALSE)

rog_gradient_pal(n = 4, alpha = 0.9, rev = FALSE)

rog_qualitative_pal(n = 6, alpha = 0.9, rev = FALSE)

Arguments

n	Number of colors to generate.
alpha	Alpha transparency for the generated colors. Use 1 for fully opaque colors.
rev	Should the palette order be reversed?

Value

Color palettes.

See Also

grDevices' grDevices::hcl.colors().

Examples

scales::show_col(rog_orange_pal(9))

scales::show_col(rog_dark_pal(9))

scales::show_col(rog_gradient_pal(9))

scales::show_col(rog_qualitative_pal(9))

---