Tired of copy and pasting almost identical markdown for badges in every new R-package that you create, on Github or other code-sharing sites? This package allows you to easily paste badges. If you want to, it will also search your DESCRIPTION file and extract the package name, license, R-version, and current projectversion and transform that into badges. It will also search for a ".travis.yml" file and create a "Travis"" badge, if you use "Codecov.io" to check your code coverage after a "Travis" build this package will also build a "Codecov.io"-badge. All the badges can be placed individually or can be placed below the top "YAML"" content of your "RMarkdown file" (Readme.Rmd) or "README.md" file. Currently creates badges for Projectstatus ("Repostatus.org"), license Travis Build Status, Codecov, Minimal R version, CRAN status, CRAN downloads, Github stars and forks, Package rank, rdocumentation, current version of your package and last change of "README.Rmd".
This package was inspired by the badgerbadger package that checks for badges of travis, code coverage open issues, dependencies and licenses. It would be nice to have a simple function that adds these things to a readme.rmd file in R. It will save you typing and searching for the exact markdown on the websites of travis, codecov, repostatus.org etc.
This package does now place the following badges /shields:
Possible future badges
Other changes initiatilzation on readme.md only (without active components)
I like to use the following workflow:
You will probably call badgecreatr only once, somewhere during your work.
If you call badgecreatr again when you already have badges, they will be recognized. [(see NEWS)]](NEWS.md)
badgecreatr is on CRAN, install using
install.packages("badgecreatr"). But is has a flaw that I have fixed in the dev version.
The newest 'developmental' version is installed with
You can use this package in multiple ways: add a bunch of badges at once with
badgecreatr::badgeplacer(), or you can add the badges with seperate commands, I have named them all
badge_* so that autocomplete will make it much easier for you to find the correct one. See the vignette about scenarios of use for more info.
Want to help or have questions? Contact me directly, use an issue, fork me or submit a pull request.
I found the projectstatus https://www.repostatus.org/ and the wonderful shields.io projects and wanted to implement that for all my packages. But that took a lot of work. Repetitive work, and I don't like that.
The badgerbadgerbadger project in ruby did all these things automatically. I wanted to do the same thing for R projects. And I did.
All notable changes to this project will be documented in this file. This project tries to adhere to Semantic Versioning.
This version of badgecreatr has breaking changes with previous versions. It was a major overhaul of the badgecreatr package with help from Florian Privé, Stephanie Locke, and Andrie de Vries. I realized I never used the package as I originally intended, but I usually added one or two badges by name. So I have exported all the functions for interactive use. And added new badges. To help others I have added a vignette that describes how to add new badges.
badge_*: badge_projectstatus, badge_travis, badge_codecov , badge_minimal_r_version, badge_cran, badge_packageversion, badge_last_change, badge_last_change_static, badge_rdocumentation, badge_github_star, badge_github_fork, badge_licence, badge_rank, badge_cran_*
*badge: projectstatusbadge, travisbadge, codecovbadge, minimal_r_version_badge, cranbadge, packageversionbadge, and last_change_badge. The use of the word licence (I have changed all the words to the spelling "license", US spelling)
Currently creates badges for Codecov, last change, travis, projectstatus and licence.
Started project with readme and several functions