create_logo: Create a branding logo for a teachingApp

Description Usage Arguments Details Value See Also

View source: R/add_logo.R

Description

Create a branding logo for a teachingApp

Usage

1
(app_dir = NULL, git_user = NULL, icon = NULL, img = NULL)

Arguments

app_dir

character Directory in which the app files are located

git_user

character GitHub account username (see details)

icon

character Name of a fontAwesome icon printed in the app footer

img

character Path to an image printed in the app footer

Details

This function should not be called directly, but is invoked by add_optionss when an app is rendered.

By default, the branding logo is the GitHub fontAwesome icon ('fa fa-github'). If img is specified, it takes precedence oven icon.

Hovering over the logo will reveal a link to view the code used to create the app. This is helpful in a teaching environment, where students often are interested in understanding how an app functions. The URL for the link is of the form (https://github.comgit_userapp_pkgblob/master/inst/apps) where app_pkg is created dynamically.

Value

HTML code for inserting a logo (icon or image) in the footer of a navbarPage app

See Also

add_options

add_logo


teachingApps documentation built on July 1, 2020, 5:58 p.m.