Package 'gfonts'

Download font files

Description

Download font files

Usage

download_font(id, output_dir, variants = NULL, ..., http_options = list())

Arguments

id	Id of the font, correspond to column id from get_all_fonts.
output_dir	Output directory where to save font files.
variants	Variant(s) to download, default is to includes all available ones.
...	Additional parameters to API query.
http_options	Arguments passed to crul::HttpClient$new.

Value

a character vector of the filepaths extracted to, invisibly.

Examples

if (interactive()) {

# For example, we use a temporary directory
path_to_dir <- tempfile()
dir.create(path_to_dir)

# Download Roboto font
download_font(
  id = "roboto",
  output_dir = path_to_dir
)

# Get only regular, italic and bold
download_font(
  id = "roboto",
  output_dir = path_to_dir,
  variants = c("regular", "300italic", "700")
)

# Clean up
unlink(path_to_dir, recursive = TRUE)

}

---

Generate CSS to import fonts

Description

Generate CSS to import fonts

Usage

generate_css(
  id,
  variants = NULL,
  subsets = NULL,
  output = NULL,
  font_dir = "../fonts/",
  prefer_local_source = TRUE,
  browser_support = c("best", "modern"),
  ...
)

Arguments

id	Id of the font, correspond to column id from get_all_fonts.
variants	Variant of font to use.
subsets	Subsets to use.
output	Specifies path to output file for CSS generated.
font_dir	Fonts directory relative to ouput.
prefer_local_source	Generate CSS font-face rules in which user installed fonts are preferred. Use FALSE if you want to force the use of the downloaded font.
browser_support	Browser to support, choose "best" to support old browser or "modern" for only recent ones.
...	Arguments passed to crul::HttpClient$new.

Value

a character string with CSS code (invisibly).

Examples

if (interactive()) {

# Generate CSS code to use Roboto font
cat(generate_css("roboto", "regular"))

}

---

Get infos about all fonts available

Description

Retrieve from API all fonts currently available. Use the id field in other functions to reference the font you want to use.

Usage

get_all_fonts(...)

Arguments

...	Arguments passed to crul::HttpClient$new.

Value

a data.frame.

Examples

if (interactive()) {

 # Retrieve all fonts currently available
 all_fonts <- get_all_fonts()

}

---

Get detailed information about a font

Description

Get detailed information about a font

Usage

get_font_info(id, subsets = NULL, ...)

Arguments

id	Id of the font, correspond to column id from get_all_fonts.
subsets	Select charsets, for example "latin".
...	Arguments passed to crul::HttpClient$new.

Value

a data.frame.

Examples

if (interactive()) {

 # Info about Roboto
 roboto <- get_font_info("roboto")

}

---

Use Google fonts offline

Description

Download Google fonts and generate CSS to use in rmarkdown documents and shiny applications. Some popular fonts are included and ready to use.

Download a font

Use setup_font to get a font inside your current project, then in a {shiny} application or {rmarkdown} document, you can use use_font to import the font.

Ready-to-use fonts

Some fonts are included in this package and can be used directly with use_pkg_gfont.

Author(s)

Victor Perrier (@dreamRs_fr)

---

Detail about included fonts.

Description

Id and version of fonts included and available through use_pkg_gfont.

Usage

included_fonts

Format

A data frame with 8 rows and 5 variables:

id

Id for the font.

family

Name of the font.

category

Category.

version

Version number.

lastModified

Last modified date.

Source

https://gwfh.mranftl.com

---

Setup a font to be used in Shiny or Markdown

Description

This function will download the specified font into a directory of your project and generate CSS code to use it in a Shiny application or RMarkdown document.

Usage

setup_font(
  id,
  output_dir,
  variants = NULL,
  subsets = NULL,
  prefer_local_source = TRUE,
  browser_support = c("best", "modern"),
  ...
)

Arguments

id	Id of the font, correspond to column id from get_all_fonts.
output_dir	Output directory where to save font and CSS files. Must be a directory.
variants	Variant(s) to download, default is to includes all available ones.
subsets	Subsets to download.
prefer_local_source	Generate CSS font-face rules in which user installed fonts are preferred. Use FALSE if you want to force the use of the downloaded font.
browser_support	Browser to support, choose "best" to support old browser or "modern" for only recent ones.
...	Arguments passed to crul::HttpClient$new.

Value

None.

Note

Two directories will be created (if they do not exist) in the output_dir specified: fonts/ and css/.

Examples

if (interactive()) {

# For example, we use a temporary directory
path_to_www <- tempfile()
dir.create(path_to_www)

# In a Shiny app, you can use the www/ directory
# in Markdown, use a subfolder of your Rmd directory
setup_font(
  id = "open-sans-condensed",
  output_dir = path_to_www
)

# Clean up
unlink(path_to_www, recursive = TRUE)

}

---

Generate HTML tags used in examples

Description

Generate HTML tags used in examples

Usage

tag_example(class = NULL)

Arguments

class

Class of the main div.

Value

HTML tags.

Examples

tag_example()

---

Use a downloaded font in Shiny or Markdown

Description

Use a downloaded font in Shiny or Markdown

Usage

use_font(id, css_path, selector = "body", css = NULL)

Arguments

id	Id of the font downloaded.
css_path	Path to CSS generated by setup_font.
selector	CSS selector for which to use the font, usually an HTML tag, default to "body" (all document).
css	CSS variables needed to use font, normally this should be automatic.

Value

an HTML tag with an HTML dependency (htmlDependency).

Examples

if (interactive()) {
  library(gfonts)

  # Here we use a temp directory
  # but in Shiny, it can be www/ folder
  directory <- tempfile()
  dir.create(directory)

  # Setup a font (only needed once)
  setup_font(
    id = "dancing-script",
    output_dir = directory
  )

  library(shiny)

  ui <- fluidPage(

    # Use font
    use_font(
      id = "dancing-script",
      css_path = file.path(directory, "css/dancing-script.css")
    ),

    tags$p(
      paste(letters, collapse = "")
    ),
    tags$p(
      paste(LETTERS, collapse = "")
    ),
    tags$p(
      style = "font-weight: bold;",
      paste(letters, collapse = "")
    ),
    tags$p(
      style = "font-weight: bold;",
      paste(LETTERS, collapse = "")
    ),
    tags$p(
      style = "font-style: italic;",
      paste(letters, collapse = "")
    ),
    tags$p(
      style = "font-style: italic;",
      paste(LETTERS, collapse = "")
    ),
    tags$h1("First level title"),
    tags$h2("Second level title"),
    tags$h3("Third level title"),
    tags$h4("Fourth level title"),
    tags$h5("Fifth level title"),
    tags$h6("Sixth level title")
  )

  server <- function(input, output, session) {

  }
  shinyApp(ui, server)
}

---

Use a Google Font included in gfonts

Description

For convenience, some fonts are included in the package, you can use them without having to download them, but only few variants are available.

Usage

use_pkg_gfont(
  font = c("roboto", "open-sans", "lato", "montserrat", "alegreya", "nunito-sans",
    "baloo", "happy-monkey", "henny-penny", "poppins", "oswald"),
  selector = "body"
)

Arguments

font	Name of the font to use, possible choices are: "roboto", "open-sans", "lato", "montserrat", "alegreya", "nunito-sans", "baloo", "happy-monkey", "henny-penny".
selector	CSS selector for which to use the font, usually an HTML tag, default to "body" (all document).

Value

An HTML tag with an htmlDependency.

Examples

if (interactive()) {

  library(gfonts)
  library(htmltools)

  browsable(tags$div(
    use_pkg_gfont("open-sans"),
    tag_example(),
    tags$h1("First level title"),
    tags$h2("Second level title"),
    tags$h3("Third level title"),
    tags$h4("Fourth level title"),
    tags$h5("Fifth level title"),
    tags$h6("Sixth level title")
  ))


  browsable(tags$div(
    use_pkg_gfont("henny-penny"),
    tag_example(),
    tags$h1("First level title"),
    tags$h2("Second level title"),
    tags$h3("Third level title"),
    tags$h4("Fourth level title"),
    tags$h5("Fifth level title"),
    tags$h6("Sixth level title")
  ))

}

---