kitten {pkgKitten} | R Documentation |
Create a very simple package
Description
The kitten
function creates an (almost) empty example
package.
Usage
kitten(name = "anRpackage", path = ".", author, maintainer, email,
license = "GPL (>= 2)", puppy = TRUE, bunny = TRUE)
Arguments
name |
The name of the package to be created, defaults to “anPackage” |
path |
The path to the location where the package is to be created, defaults to the current directory. |
author |
The name of the author, defaults to the result of
|
maintainer |
The name of the maintainer, also defaults to
|
email |
The maintainer email address, defaults to
|
license |
The license of the new package, defaults to “GPL-2”. |
puppy |
Toggle whether |
bunny |
Toggle whether |
Details
The kitten
function can be used to initialize a simple
package. It is created with the minimal number of files. What
distinguished it from the function package.skeleton()
in
base R (which it actually calls) is that the resulting package
passes R CMD check cleanly
.
Because every time you create a new package which does not
pass R CMD check
, a kitten experiences an existential
trauma. Just think about the kittens.
Value
Nothing is returned as the function is invoked for its side effect of creating a new package.
Author(s)
Dirk Eddelbuettel