search_repo_logo: Searches a given github repo URL for the best hex logo image.

In hexFinder: Find Hex Logos for CRAN Packages

Searches a given github repo URL for the best hex logo image.

Description

Searches a given github repo URL for the best hex logo image.

Usage

search_repo_logo(
  pkg_name,
  repository,
  token = Sys.getenv("github_pat"),
  logo_patterns = getOption("hexFinder.logo_patterns"),
  ignore_patterns = getOption("hexFinder.ignore_patterns")
)

Arguments

pkg_name	The mane of the package we want the logo for.
repository	The github repository to search in.
token	A github personal access token. variable github_pat. If that variable is not set, you might run into API limits when running too many queries.
logo_patterns	String of valid name.extension file names for files to look for, separated by |. pkg_name Can be used as a placeholder for the package name.
ignore_patterns	String of patterns to ignore when looking for a valid logo. Can be part of the filename or part of the file path.

Value

A URL to a image or NULL if no image was found

hexFinder documentation built on Feb. 16, 2023, 8:11 p.m.