badgeplacer {badgecreatr}R Documentation

Place badges inside a readme.Rmd file

Description

This is the main function to add badges to your readme.

Usage

badgeplacer(location = ".", status = "active", githubaccount = NULL,
  githubrepo = NULL, branch = NULL, name = "README.Rmd")

Arguments

location

folder where readme.rmd resides

status

one of: "concept", "wip", "suspended", "abandoned", "active", "inactive", or "unsupported"

githubaccount

your githubname

githubrepo

your githubrepositoryname

branch

master, develop, etc.

name

which file to place badges in, defaults to README.Rmd

Value

readme file with added badges


[Package badgecreatr version 0.2.0 Index]