Project Status: Active ? The project has reached a stable, usable state and is being actively developed. Licence Build Status codecov


minimal R version CRAN_Status_Badge packageversion


Last-changedate

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:

Possible future badges

Workflow

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 CHANGELOG)]](CHANGELOG.md)

Installation

For now you will have to install using devtools::install_github("rmhogervorst/badgecreatr") Whenever you have created a readme, use badgeplacer() or don't even load the package I would just call badgecreatr::badgeplacer(githubaccount = "RMHogervorst",githubrepo = "badgecreatr") for this package.

And if I would just start with this package I would make a different status:

badgecreatr::badgeplacer(status = "wip" , githubaccount = "RMHogervorst",githubrepo = "badgecreatr") Which would make this a work in progress status badge.

Use

You will have to supply the github accountname, repo and branch. I'm working to automatically recognize those.

Contact

Want to help or have questions? contact me, fork me or send a pull request!

Inspiration

I found the projectstatus http://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.