Package 'jdenticon'

Title: A Wrapper for the Node.js 'Jdenticon' Library
Description: A Wrapper for the Node.js 'Jdenticon' <https://jdenticon.com/> Library. Uses 'esbuild' <https://esbuild.github.io/> to reduce user dependencies.
Authors: Matt Roumaya [aut, cre, cph] , Richard D. Morey [ctb]
Maintainer: Matt Roumaya <[email protected]>
License: MIT + file LICENSE
Version: 0.1.1
Built: 2024-10-29 03:30:56 UTC
Source: https://github.com/mattroumaya/jdenticon

Help Index

Create a Jdenticon.

Description

Create a Jdenticon.

Usage

jdenticon(
  value = NULL,
  filePath = tempdir(),
  fileName = glue::glue("jdenticon_{size}_{value}"),
  size = "100",
  config = NULL,
  type = "png",
  preview = interactive() && Sys.getenv("RSTUDIO") == "1",
  return_list = FALSE
)

Arguments

value

character Value to be converted to hexadecimal hash to render Jdenticon. Cannot contain characters that are reserved for filepaths:
filePath

character File path to save Jdenticon .png to. If NULL, defaults to current working directory.
fileName

character File name to save Jdenticon .png as. If NULL, defaults to ⁠temp_jdenticon_{value}⁠.
size

numeric Size of Jdenticon. Default == 100.
config

list of jdenticon configuration options (see the jdenticon documentation)
type

Image type (default 'png', or 'svg')
preview

boolean Preview Jdenticon in viewer pane?
return_list

boolean Return full list object with all settings?

Value

Path to Jdenticon icon file, or (if return_list is true) a list with all parameters (including path).

Examples

## Not run: 
jdenticon(value = 'mango')

## End(Not run)

Install jdenticon npm dependency.

Description

Install jdenticon npm dependency.

Usage

jdenticon_npm_install(force = FALSE)

Arguments

force

boolean If TRUE, automatically proceeds with npm installation. If FALSE (default), prompts user before proceeding with npm installation.

Value

Updated inst/node_modules folder.

Examples

## Not run: 
jdenticon_npm_install(force = TRUE)

## End(Not run)