Title: | Create Simple Packages Which Do not Upset R Package Checks |
---|---|
Description: | Provides a function kitten() which creates cute little packages which pass R package checks. This sets it apart from package.skeleton() which it calls, and which leaves imperfect files behind. As this is not exactly helpful for beginners, kitten() offers an alternative. Unit test support can be added via the 'tinytest' package (if present), and documentation-creation support can be added via 'roxygen2' (if present). |
Authors: | Dirk Eddelbuettel [aut, cre] |
Maintainer: | Dirk Eddelbuettel <[email protected]> |
License: | GPL (>= 2) |
Version: | 0.2.4 |
Built: | 2024-08-30 17:17:50 UTC |
Source: | https://github.com/eddelbuettel/pkgkitten |
kitten
function.
The base R function package.skeleton()
is very helpful, but
insist on creating packages which do not pass R CMD check
.
That is silly,
This package helps with this issue. No more, no less.
Dirk Eddelbuettel wrote the package and maintains it.
package.skeleton
,
the ‘Writing R Extensions’ manual.
The kitten
function creates an (almost) empty example
package.
kitten(name = "anRpackage", path = ".", author, maintainer, email, license = "GPL (>= 2)", puppy = TRUE, bunny = TRUE)
kitten(name = "anRpackage", path = ".", author, maintainer, email, license = "GPL (>= 2)", puppy = TRUE, bunny = TRUE)
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 |
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.
Nothing is returned as the function is invoked for its side effect of creating a new package.
Dirk Eddelbuettel
The playWithPerPackageHelpPage
function creates an basic
package help page.
playWithPerPackageHelpPage(name = "anRpackage", path = ".", maintainer = "Your Name", email = "[email protected]")
playWithPerPackageHelpPage(name = "anRpackage", path = ".", maintainer = "Your Name", email = "[email protected]")
name |
The name of the package to be created, defaults to “anRpackage” |
path |
The path to the location where the package is to be created, defaults to the current directory. |
maintainer |
The name of the maintainer, defaults to
“Your Name” or |
email |
The maintainer email address. |
The playWithPerPackageHelpPage
function can be used to
create a simple help page for a package.
It has been split off from the kitten
function so that it
can be called from other packages. As such, it is also exported
from pkgKitten.
Nothing is returned as the function is invoked for its side effect of creating a new package.
Dirk Eddelbuettel