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%"
)
```



# Catchy tunes in R

<!-- [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) -->
<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable/)
[![Travis build status](https://travis-ci.com/chris-dworschak/eaRworm.svg?branch=main)](https://travis-ci.com/gitlab/chris-dworschak/eaRworm)
[![License: GPL-3](https://img.shields.io/badge/License-GPLv3-lightgrey.svg)](https://www.gnu.org/licenses/gpl-3.0)
<!-- badges: end -->

This package enables playing audio of "Merry Christmas" and "Happy Birthday" using R. It also contains a small number of arrangements that slightly deviate from the standard song versions. I developed this toy package in Christmas spirit; it will not be submitted to CRAN. Audio is dependent on a pre-installed WAV audio player that the R installation can locate.



## Installation

You can install the development version of eaRworm from [GitLab](https://gitlab.com/chris-dworschak/) with: 

``` r
remotes::install_gitlab("chris-dworschak/eaRworm") # downloads and installs the package from GitLab
```


## Example

To use `eaRworm`, simply run:


```{r example, eval=FALSE, echo=T}
library(eaRworm) # loads the package

merry.christmas(tune = "normal") # plays the standard version of "Merry Christmas"

happy.birthday(tune = "exciting") # plays a version of "Happy Birthday"

```