build_settings: Build the settings part of the request

In ARawles/faviconR: Wrapper Functions to the 'realfavicongenerator.net API'

Description

This function helps with the creation of the settings list used in the API request. Further details can be found in the realfavicongenerator.net API documentation

Usage

build_settings(
  compression = c("0", "1", "2", "3", "4", "5"),
  scaling_algorithm = c("Mitchell", "NearestNeighbor", "Cubic", "Bilinear", "Lanczos",
    "Spline"),
  error_on_image_too_small = TRUE,
  readme_file = FALSE,
  html_code_file = FALSE,
  use_path_as_is = FALSE
)

Arguments

compression	character; 1-5 level of compression (5 = higest)
scaling_algorithm	character; which scaling algorithm to use. One of "Mitchell", "NearestNeighbor", "Cubic", "Bilinear", "Lanczos", "Spline"
error_on_image_too_small	logical; whether to error if an icon cannot be produced because the image is too small
readme_file	logical; whether to inclued a README.md file to summarise the package manual installation steps
html_code_file	logical; whether to generate a html_code.html file which contains the icons' HTML markups
use_path_as_is	logical; FALSE lets RealFaviconGenerator decide the paths for you. TRUE forces RealFaviconGenerator to insert the path everywhere. Refer to the API documentation for more.

ARawles/faviconR documentation built on July 23, 2020, 1:30 p.m.