Quickly place relevant badges at the top of your readme, stop copy pasting, start on your project
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
docs
inst
man
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
NAMESPACE
NEWS.md
README.Rmd
README.md
THANKS.md
badgecreatr.Rproj
badgecreatr4.jpg
cran-comments.md
yetanotherreadme.Rmd
yetanotherreadme.md

README.md

Project Status: Active The project has reached a stable, usable state and is being actively developed. Licence codecov minimal R version CRAN_Status_Badge packageversion Last-changedate

Status Master branch: Build Status

Status Develop branch: Build Status

Introduction

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:

  • repo status according to https://www.repostatus.org/
  • licence (recognize from DESCRIPTION file)
  • travis shield
  • code coverage
  • minimal R version (recognize from DESCRIPTION file)
  • cran badge
  • packageversion (recognize from DESCRIPTION file)
  • last change (this will automagically update everytime you knit your readme.rmd)
  • finds github account and reponame automatically
  • finds local repo
  • nr of open issues
  • number of pull requests
  • rdocumentation badge

Possible future badges

  • number of downloads CRAN
  • number of dependencies and:
  • a way to visualize their version
  • project lifecycle badge as used by tidyverse

Other changes initiatilzation on readme.md only (without active components)

Workflow

I like to use the following workflow:

  • start a new project in rstudio
  • after some functions are made start a package
  • start a github repo
  • create a readme.rmd
  • ( this is where badgecreatr comes in) create badges
  • continue with the project
  • submit to cran, bioconductor, ropensci etc

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)

Installation

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 devtools::install_github("rmhogervorst/badgecreatr")

Use

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.

Contact

Want to help or have questions? Contact me directly, use an issue, fork me or submit a pull request.

star this repo fork this repo

Inspiration

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.