https://github.com/bisaloo/pkgicon
A Local and Robust Way to Generate Favicons for Package Documentation Sites
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.4%) to scientific vocabulary
Last synced: 9 months ago
·
JSON representation
Repository
A Local and Robust Way to Generate Favicons for Package Documentation Sites
Basic Info
- Host: GitHub
- Owner: Bisaloo
- Language: R
- Default Branch: main
- Homepage: http://hugogruson.fr/pkgicon/
- Size: 6.84 KB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Created 9 months ago
· Last pushed 9 months ago
Metadata Files
Readme
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# pkgicon
This is a local alternative to [pkgdown::build_favicons()].
It is also expected to work on more cases and avoid strange issues where some
logo elements were dropped from the online converter used by pkgdown.
## Installation
You can install the development version of pkgicon from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("Bisaloo/pkgicon")
```
## Example
To generate your package favicons, please the source logo (ideally saved as an `.svg`) under one of the locations recognized by pkgdown and r-universe:
- `./logo.svg` (`.` is the root of your R package, where the `DESCRIPTION` file is located)
- `./man/figures/logo.svg`
- `./logo.png`
- `./man.figures/logo.png`
And then run:
```{r, eval = FALSE}
pkgicon::build_pkgdown_favicons(
pkg = "." # change this to the path of the root of your pkg
)
```
Owner
- Name: Hugo Gruson
- Login: Bisaloo
- Kind: user
- Location: Heidelberg
- Company: EMBL
- Website: https://hugogruson.fr/
- Repositories: 102
- Profile: https://github.com/Bisaloo
Evolutionary Biologist turned Research Software Engineer in R.
GitHub Events
Total
- Push event: 3
- Create event: 2
Last Year
- Push event: 3
- Create event: 2
Dependencies
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v4 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/lint-changed-files.yaml
actions
- actions/checkout v4 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml
actions
- JamesIves/github-pages-deploy-action v4.5.0 composite
- actions/checkout v4 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION
cran
- cli * imports
- jsonlite * imports
- magick * imports
- pkgdown * imports
- rsvg * imports
- whisker * imports
- knitr * suggests
- rmarkdown * suggests