michaelweylandt/RPkgSkeleton
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
---
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
[](https://travis-ci.org/michaelweylandt/PKG) [](https://codecov.io/gh/michaelweylandt/PKG?branch=master) [](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) [](https://cran.r-project.org/package=PKG) [](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.