rpac_readme: Generates a README template for a GitHub repository

In AntonioJBT/Rpacker: Quickly Setup An R Package Using a Devtools Workflow

Generates a README template for a GitHub repository

Description

rpac_readme() creates a README, includes badges travisCI and codecov

Usage

rpac_readme(github_user = NULL, pkg_name = NULL, path = ".",
  append = TRUE)

Arguments

github_user	Pass as string, will be inserted into "https://github.com/github_user/"
pkg_name	package name as string
path	Pass a path as string. Default is current working directory ('.').
append	Append text to an existing file. Default is TRUE.

Value

Creates a README.md file in the working directory

Author(s)

Antonio J Berlanga-Taylor <https://github.com/AntonioJBT/Rpacker>

Examples

## Not run: 
rpac_readme(github_user = 'me',
            pkg_name = 'superPackage',
            path = '.'
            )

## End(Not run)

AntonioJBT/Rpacker documentation built on May 1, 2024, 1:06 a.m.