Package 'skeletor'

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.
Authors: Neal Richardson [aut, cre]
Maintainer: Neal Richardson <[email protected]>
License: MIT + file LICENSE
Version: 1.1.0
Built: 2024-09-21 05:54:12 UTC
Source: https://github.com/nealrichardson/skeletor

Help Index

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"), 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.