Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • 463e2d6
  • /
  • man
  • /
  • build_favicons.Rd
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:b252e0b4b29da2f7ac72fd7531ce96ac958d8b0a
directory badge
swh:1:dir:9598e1a76c12cbb6ba86c048169cee9324c35cc7

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
build_favicons.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/build-favicons.R
\name{build_favicons}
\alias{build_favicons}
\alias{build_favicon}
\title{Create favicons from package logo}
\usage{
build_favicons(pkg = ".", overwrite = FALSE)

build_favicon(pkg, overwrite)
}
\arguments{
\item{pkg}{Path to package.}

\item{overwrite}{If \code{TRUE}, re-create favicons from package logo.}
}
\description{
This function auto-detects the location of your package logo (with the name
\code{logo.svg} (recommended format) or \code{logo.png}) and runs it through the
\url{https://realfavicongenerator.net} API to build a complete set of favicons
with different sizes, as needed for modern web usage.
}
\details{
You only need to run the function once. The favicon set will be stored in
\code{pkgdown/favicon} and copied by \code{\link[=init_site]{init_site()}} to the relevant location when
the website is rebuilt.

Once complete, you should add \verb{pkgdown/} to \code{.Rbuildignore } to avoid a NOTE
during package checking.
}

back to top

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API