Skip to contents

Create a package skeleton

Usage

skeletor(pkg, dir = pkg, name = getOption("skeletor.name"),
  email = getOption("skeletor.email"),
  github = getOption("skeletor.github"), api = FALSE)

Arguments

pkg

character: name for your new package

dir

character: path in which to create the package. Default is pkg

name

character: your name. Default is 'skeletor.name' from options. See configure() to set name, email, and github in your .Rprofile so that you don't need to pass them in here.

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.

api

logical: is this package an API wrapper? If TRUE, an api.R file of boilerplate code will be added, httr will be added to Imports, httptest will be added to Suggests, and some basic tests of the wrapping code will be added. Default is FALSE.

Value

The path, dir, invisibly.