Friendly Craftsman Who Builds Slick R Packages
Mason builds R packages. It asks you some simple questions, fills in a template based on your answers, and creates proper metadata files, READMEs with badges, git repositories, everything you need to just start writing and committing your code.
Mason is extensible: each template is a separate R package named
mason.<template>
, where <template>
is the name of the template. To use
a new template, you need to install it first. Mason will be then able to
use it immediately, without any configuration. See
e.g. mason.rpkg for a generic
R package template.
Mason makes sure that you get your package as quick as possible, with the
least number of keystrokes: it tries to find out your username, name email
address, GitHub login name, etc. from your settings, to give you reasonable
defaults, so that all you need to do is press ENTER
a couple of times.
Mason's role model is Yeoman.
You can install Mason and its dependencies from GitHub, using the
devtools
package:
devtools::install_github("metacran/mason")
You need to install at least one template as well:
devtools::install_github("metacran/mason.rpkg")
devtools::install_github("metacran/mason.github")
Create an empty directory and make that your current directory. The new package will be created within that:
dir.create("mypackage")
setwd("mypackage")
Then just call Mason with the name of the template:
mason::mason("github")
MIT © Gábor Csárdi.