Generating and customizing badges in r-universe

[This article was first published on rOpenSci - open tools for open science, and kindly contributed to R-bloggers]. (You can report issue about the content on this page here)
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

This post is part of a series of technotes about r-universe, a new umbrella project by rOpenSci under which we experiment with various ideas for improving publication and discovery of research software in R. As the project evolves, we will post updates to document features and technical details. For more information, visit the r-universe project page.

🔗 Badges in r-universe

After creating your personal universe, the dashboard on https://{yourname}.r-universe.dev shows the version and other details for each package in your repository. We have also added a new tab that lists the available badges for the repository.

screenshot of the badges tab

Badges provide a nice way to display the status of your repository or individual packages within external webpages, such as a README file, your homepage, or your personal or organization profile README on GitHub.

There are currently two types of badges in r-universe: individual package badges showing the current package version, and global badges (where the endpoint is prefixed with :) that show the name, count, and status of the entire repository.

🔗 Package version badges

The /badges/{pkg} API yields a badge with the current version of the given package in the repository. A common place to display this badge is in the package README file, together with the package installation instructions.

If the package is also on CRAN, you could position it next to a badge from r-pkg.org to contrast it with the current CRAN version and installation instructions, see for example the gert package README:

![runiverse-name example badge](https://ropensci.r-universe.dev/badges/:name)
![runiverse-package example badge for gert package](https://ropensci.r-universe.dev/badges/gert)
![cran-badge example for gert package](http://www.r-pkg.org/badges/version/gert)

Which looks like below. Here users can immediately see from the README that the package is available from the ropensci universe, and that the version from r-universe is higher than the CRAN version.

screenshot of the gert package showing the badge in use

🔗 Repository status badges

Besides badges for individual packages, the system also provides a few badges with information about the status of the entire package repository. For example:

  • /badges/:name the name of the universe, i.e. your github username
  • /badges/:total the total number of packages in the repository
  • /badges/:registry if the latest monorepo update was successful, i.e. if your package registry is OK

The last badge in particular may be useful for yourself. If will go red when something is wrong with your package registry file. This usually means your packages.json may reference git repositories or branches that do not exist, or the system did not find a proper package in the given location.

This is what the badges look like for the ropensci universe:

![runiverse-name](https://ropensci.r-universe.dev/badges/:name)
![runiverse-registry](https://ropensci.r-universe.dev/badges/:registry)
![runiverse-total](https://ropensci.r-universe.dev/badges/:total)

runiverse-name example badge runiverse-registry example badge runiverse-total example badge

🔗 Customize the badge style

One of the early adopters of R-universe had requested some options to customize the visual appearance of the badges. We have added 3 http parameters to the badges API:

  • scale the size of the badge (where 1 is the default);
  • color the color of a badge;
  • style set to “flat” to get retro style badges.

For example: https://ropensci.r-universe.dev/badges/:total?scale=2&color=pink&style=flat

example of badge with customized styling

The badgen docs show more details about these parameters. Our backend for this API is fairly straight-forward, try sending a pull request if you have ideas for other useful badges.

To leave a comment for the author, please follow the link and comment on their blog: rOpenSci - open tools for open science.

R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

Never miss an update!
Subscribe to R-bloggers to receive
e-mails with the latest R posts.
(You will not see this message again.)

Click here to close (This popup will not appear again)