| Type: | Package |
| Title: | An R Package Skeleton Generator |
| Description: | A tool for bootstrapping new packages with useful defaults, including a test suite outline that passes checks and helpers for running tests, checking test coverage, building vignettes, and more. Package skeletons it creates are set up for pushing your package to 'GitHub' and using other hosted services for building and test automation. |
| Version: | 1.0.4 |
| Date: | 2017-04-09 |
| Author: | Neal Richardson [aut, cre] |
| Maintainer: | Neal Richardson <neal.p.richardson@gmail.com> |
| URL: | https://github.com/nealrichardson/skeletor |
| BugReports: | https://github.com/nealrichardson/skeletor/issues |
| License: | MIT + file LICENSE |
| Depends: | R (≥ 3.0.0) |
| Suggests: | covr, testthat |
| RoxygenNote: | 6.0.0 |
| NeedsCompilation: | no |
| Packaged: | 2017-04-09 20:59:05 UTC; neal.richardson |
| Repository: | CRAN |
| Date/Publication: | 2017-04-09 21:12:13 UTC |
Set some personal defaults for skeletor
Description
Set some personal defaults for skeletor
Usage
configure(name = NULL, email = NULL, github = NULL,
file = "~/.Rprofile")
Arguments
name |
character: your name |
email |
character: your email address |
github |
character: your GitHub account |
file |
character: file path to set these in as options. Default is your personal .Rprofile file. |
Value
Invisibly, the options set in file. Typically, you'll call
this function only once, and only for its side effects of adding the values
to your .Rprofile so that skeletor() will find them there without
your having to enter them each time.
Create a package skeleton
Description
Create a package skeleton
Usage
skeletor(pkg, dir = pkg, name = getOption("skeletor.name"),
email = getOption("skeletor.email"),
github = getOption("skeletor.github"))
Arguments
pkg |
character: name for your new package |
dir |
character: path in which to create the package. Default is |
name |
chararacter: your name. Default is 'skeletor.name' from options.
See |
email |
character: your email address. Likewise taken from option 'skeletor.email' by default. |
github |
character: the GitHub account where you will push this new package. Likewise taken from option 'skeletor.github' by default. |
Value
The path, dir, invisibly.