README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# peacock

<!-- badges: start -->
<!-- badges: end -->

The goal of peacock is to provide functions for project initialization and workflows using pre-build templates. Templates available for R and R Shiny projects. 

## Installation

You can install the development version of peacock from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("samuelbharti/peacock")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(peacock)
## Initialize shiny project structure
init_shiny()
```