generator-r-bones

0.0.5 • Public • Published

R-bones

Project Status travis appveyor codecov Codacy Badge npm version npm download

A yeoman generator for R projects.

Introduction

R-bones is a yeoman-generator for R-projects using Rcpp and 'RcppEigen'. Projects created with R-bones are ready for publication to CRAN or Bioconductor. The generator creates

  • a GPL3 license,
  • an Rcpp/RcppEigen integration,
  • static code analysis and reports using lintr,
  • a unit-test suite using testthat,
  • badges for the project status, build status using Travis CI/Appveyor and code coverage using Codecov,
  • documentation with roxygen and a custom vignette,
  • example S3, S4 methods and classes,
  • custom NEWS, README.md, TODO.md and VERSIONS.md files,
  • a prototype hello.R, hello.cpp and testthat.R.

The resulting folder-structure looks like this:

    |____.codecov.yml
    |____.gitattributes
    |____.gitignore
    |____.lintr
    |____.Rbuildignore
    |____.travis.yml
    |____.yo-rc.json
    |____appveyor.yml
    |____DESCRIPTION
    |____emptypRoject.Rproj
    |____inst
    | |____NEWS
    |____LICENSE
    |____R
    | |____class.R
    | |____emptypRoject-package.R
    | |____hello.R
    |____README.md
    |____src
    | |____hello.cpp
    |____tests
    | |____testthat
    | | |____test.R
    | |____testthat.R
    |____TODO.md
    |____VERSIONS.md
    |____vignettes
    | |____emptypRoject.Rmd

Installation

Yeoman comes with npm, so install it first and then call:

  npm install -g yo
  npm install -g generator-R-bones

Once you have the package, you can create a scaffold using:

  yo r-bones

This builds the skeleton. Afterwards modify the sources and documentation and build both using:

  R CMD build package && R CMD install package.tar.gz

Author

Package Sidebar

Install

npm i generator-r-bones

Weekly Downloads

9

Version

0.0.5

License

GPL-3.0

Unpacked Size

95.5 kB

Total Files

39

Last publish

Collaborators

  • dirmeier