https://github.com/nealrichardson/skeletor

An R Package Skeleton Generator
https://github.com/nealrichardson/skeletor

codecov skeleton-generator testing travis-ci

Last synced: 16 days ago
JSON representation

An R Package Skeleton Generator

• Host: GitHub
• URL: https://github.com/nealrichardson/skeletor
• Owner: nealrichardson
• License: other
• Created: 2016-04-08T04:24:11.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-04-07T13:59:50.000Z (over 1 year ago)
• Last Synced: 2024-10-04T13:17:47.825Z (about 1 month ago)
• Topics: codecov, skeleton-generator, testing, travis-ci
• Language: R
• Homepage:
• Size: 52.7 KB
• Stars: 21
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - nealrichardson/skeletor - An R Package Skeleton Generator (R)

README

        
# skeletor: An R Package Skeleton Generator

[![Build status](https://ci.appveyor.com/api/projects/status/28hsiu1b9ntisto7/branch/master?svg=true)](https://ci.appveyor.com/project/nealrichardson/skeletor/branch/master)  [![codecov](https://codecov.io/gh/nealrichardson/skeletor/branch/master/graph/badge.svg)](https://codecov.io/gh/nealrichardson/skeletor) [![cran](https://www.r-pkg.org/badges/version-last-release/skeletor)](https://cran.r-project.org/package=skeletor)

Skeletor is a tool for bootstrapping new packages with useful defaults and scaffolding. Package skeletons it creates contain a test suite outline and hooks for adding documentation. They also are created with a Makefile to facilitate running tests, checking test coverage, building vignettes, and more. Skeletor also sets up packages to use git/GitHub for version control and Travis-CI to build and test your packages whenever you push to GitHub. Integrations with Codecov.io and Appveyor are also made effortless, and with one additional argument, you can get additional boilerplate and testing setup for writing an R package that wraps an API.

While other R package skeletons exist, I found that I never used them. The defaults of the base R's `package.skeleton()`, copying functions from the current R session, never are what I want, and what `devtools::create()` makes is too bare. I found that I was starting every package by copying the last package I made, deleting its code and tests, and renaming everything. `skeletor` automates that.

## Installing

`skeletor` is available on CRAN:

    install.packages("skeletor")

The pre-CRAN-release version of the package can be pulled from GitHub using the [devtools](https://github.com/r-lib/devtools) package:

    # install.packages("devtools")

    devtools::install_github("nealrichardson/skeletor")

## Using

Skeletor provides two functions: (1) `skeletor()`, which makes package skeletons, and (2) `configure()`, which sets a few parameters in your .Rprofile so that you don't need to provide them each time. These parameters, which are inserted into the package skeleton template, are:

* **name**: your name

* **email**: your email address

* **github**: your GitHub username

After installing, run `configure()` once to set these, like:

    > library(skeletor)

    > configure(name="Neal Richardson", email="[email protected]",

        github="nealrichardson")

Thereafter, simply running

    $ R -e 'skeletor::skeletor("wittynamehere")'

from the shell will create a package called "wittynamehere" in a same-named subdirectory of your current working directory, and it will insert your name, email, and GitHub account into the appropriate parts of the package. Then you can open that directory's contents in your favorite IDE or text editor. You also can immediately run tests on your new package with `make test` or by running `R CMD check` on it. See the new package's README.md file for further instructions on how to finish setting it up with GitHub and other hosted services.

`skeletor()` takes one additional argument, `api`, which if `TRUE` will add to the skeleton an `R/api.R` with basic functions for wrapping an API, and the test suite will use the [`httptest`](https://enpiar.com/r/httptest/) package.

## For developers

The repository---and the repositories it creates---include a Makefile to facilitate some common tasks.

### Running tests

`$ make test`. Requires the [testthat](http://testthat.r-lib.org) package. You can also specify a specific test file or files to run by adding a "file=" argument, like `$ make test file=configure`. `test_package` will do a regular-expression pattern match within the file names. See its documentation in the `testthat` package.

### Updating documentation

`$ make doc`. Requires the [roxygen2](https://github.com/r-lib/roxygen2) package.