https://github.com/jacobcvt12/cookiecutter-R-package

https://github.com/jacobcvt12/cookiecutter-R-package

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jacobcvt12/cookiecutter-R-package
• Owner: jacobcvt12
• Created: 2015-09-07T17:01:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-07-10T16:56:17.000Z (almost 6 years ago)
• Last Synced: 2024-08-13T07:14:48.225Z (8 months ago)
• Language: R
• Size: 16.6 KB
• Stars: 11
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - jacobcvt12/cookiecutter-R-package - (R)

README

        
# cookiecutter-R-package #

[![Build Status](https://travis-ci.org/Jacobcvt12/cookiecutter-R-package.svg?branch=master)](https://travis-ci.org/Jacobcvt12/cookiecutter-R-package)

Cookiecutter template for an R package. See https://github.com/audreyr/cookiecutter.

* Adds package-name.R with boilerplate for [Roxygen2](https://cran.r-project.org/package=roxygen2)

* Adds basic .travis.yml file for [Travis-CI](http://docs.travis-ci.com/user/languages/r/) builds

* Includes .gitignore and .Rbuildignore to cover most use cases.

* Includes Rmarkdown vignette example with necessary DESCRIPTION file.

* Adds basic [testthat](https://cran.r-project.org/package=testthat) framework.

* Includes other basic R boilerplate code.

# Usage

Generate an R package project:

    `cookiecutter https://github.com/Jacobcvt12/cookiecutter-R-package.git`

Then:

* Create a repo and put it there.

* Add the repo to your Travis CI account.