The rpkgskeleton from michaelweylandt

rpkgskeleton's Introduction

---
output:
  md_document:
    variant: markdown_github
---

<!--  -*- coding: utf-8 -*- -->
<!-- README.md is generated from README.Rmd. Do not edit this file directly -->


```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "figs/README-"
)
```

# PKG

[![Travis-CI Build Status](https://api.travis-ci.org/michaelweylandt/PKG.svg)](https://travis-ci.org/michaelweylandt/PKG) [![codecov Coverage Status](https://codecov.io/gh/michaelweylandt/PKG/branch/master/graph/badge.svg)](https://codecov.io/gh/michaelweylandt/PKG?branch=master) [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-brightgreen.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/PKG)](https://cran.r-project.org/package=PKG) [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)

To use this skeleton, first clone it from github and then: 

1. Change the placeholder `PKG` to your package name everywhere it appears. 

   The command `grep -rin "PKG" . && find . -name "*PKG*"` should not find anything.

2. Update the text in the `DESCRIPTION` and `R/PKG-package.R` files.

3. Set up Travis and CodeCov

4. Delete these instructions and begin working on your package!

PACKAGE TEXT GOES HERE

## Installation

The newest version of the package can be installed from Github:

```{r, eval=FALSE}
library(devtools)
install_github("michaelweylandt/PKHG", ref="build")
```

## Usage

TEXT GOES HERE

## Authors

* [Michael Weylandt](http://github.com/michaelweylandt)

    Department of Statistics, Rice University

## Acknowledgements

* MW was funded by an NSF Graduate Research Fellowship 1450681.

Recommend Projects