get_image: Get sign image

View source: R/get_image.R

get_imageR Documentation

Get sign image

Description

This function inputs an ID number and downloads the image of the corresponding sign entry in the selected language.

Usage

get_image(
  id,
  filename = NULL,
  path = NULL,
  lang = "sts",
  overlay = FALSE,
  skip = 0,
  blend = 80,
  trim = 1
)

Arguments

id

ID number for the sign

filename

The filename of the downloaded image

path

The path to the downloaded image

lang

The target sign language (i.e. "STS" or "ASL")

overlay

Optional argument if overlay image wanted (default = 'FALSE')

skip

Whether to skip one image before applying pairwise composite (if overlay = 'TRUE')

blend

Level of blending between images (if overlay = 'TRUE')

trim

Optional argument for horizontal image trim (0 to 1; default = 1)

Details

Arguments available for STS only: Options include creating side-by-side or overlay images (default = 'FALSE') and whether a horizontal trim (0 to 1; default = 1) should be applied.

Value

The path of the image file that was downloaded


borstell/signglossR documentation built on June 11, 2025, 5:58 a.m.