https://github.com/RMHogervorst/badgecreatr

Quickly place relevant badges at the top of your readme, stop copy pasting, start on your project
https://github.com/RMHogervorst/badgecreatr

badge cran package shield

Last synced: 5 months ago
JSON representation

Quickly place relevant badges at the top of your readme, stop copy pasting, start on your project

• Host: GitHub
• URL: https://github.com/RMHogervorst/badgecreatr
• Owner: RMHogervorst
• Created: 2016-04-24T15:38:01.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-02-09T10:28:48.000Z (about 6 years ago)
• Last Synced: 2024-08-13T07:13:42.357Z (8 months ago)
• Topics: badge, cran, package, shield
• Language: R
• Homepage: http://rmhogervorst.nl/badgecreatr
• Size: 282 KB
• Stars: 61
• Watchers: 4
• Forks: 22
• Open Issues: 15
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

Awesome Lists containing this project

• jimsghstars - RMHogervorst/badgecreatr - Quickly place relevant badges at the top of your readme, stop copy pasting, start on your project (R)

README

        
---

output: github_document

---

[![Project Status: Active  The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![Licence](https://img.shields.io/badge/licence-GPL--3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)  [![codecov](https://codecov.io/gh/RMHogervorst/badgecreatr/branch/master/graph/badge.svg)](https://codecov.io/gh/RMHogervorst/badgecreatr) [![minimal R version](https://img.shields.io/badge/R%3E%3D-3.2.4-6666ff.svg)](https://cran.r-project.org/)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/badgecreatr)](https://cran.r-project.org/package=badgecreatr)

[![packageversion](https://img.shields.io/badge/Package%20version-0.1.0-orange.svg?style=flat-square)](commits/develop)

[![Last-changedate](https://img.shields.io/badge/last%20change-`r gsub('-', '--', Sys.Date())`-yellowgreen.svg)](/commits/master)

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

Status Master branch: [![Build Status](https://travis-ci.org/RMHogervorst/badgecreatr.svg?branch=master)](https://travis-ci.org/RMHogervorst/badgecreatr)

Status Develop branch: [![Build Status](https://travis-ci.org/RMHogervorst/badgecreatr.svg?branch=develop)](https://travis-ci.org/RMHogervorst/badgecreatr)

# Introduction

This package was inspired by the [badgerbadger](https://github.com/badges/badgerbadgerbadger) 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:

- [x] repo status according to 

- [x] licence (recognize from DESCRIPTION file)

- [x] travis shield

- [x] code coverage

- [x] minimal R version (recognize from DESCRIPTION file)

- [x] cran badge

- [x] packageversion (recognize from DESCRIPTION file)

- [x] last change (this will automagically update everytime you knit your readme.rmd)

- [x] finds github account and reponame automatically

- [x] finds local repo

- [x] nr of open issues

- [x] number of pull requests

- [x] rdocumentation badge

Possible future badges

- [x] 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](https://cran.r-project.org/package=badgecreatr),

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](inst/doc/general_use_of_the_package.html) for more info.

# Contact

Want to help or have questions?

Contact me directly, use an [issue](https://github.com/RMHogervorst/badgecreatr/issues), fork me or submit a pull request.

[![star this repo](https://githubbadges.com/star.svg?user=RMHogervorst&repo=badgecreatr&style=flat)](https://github.com/RMHogervorst/badgecreatr)

[![fork this repo](https://githubbadges.com/fork.svg?user=RMHogervorst&repo=badgecreatr&style=flat)](https://github.com/RMHogervorst/badgecreatr/fork)

## Inspiration

I found the projectstatus  and the wonderful

[shields.io](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](https://sam.pikesley.org/projects/badger/) project in

ruby did all these things automatically. I wanted to do the same thing for R

projects. And I did.