README.Rmd

---
output: github_document
editor_options: 
  chunk_output_type: console
---

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

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

library(badger)
```

# ohwhaley  <img src="inst/figures/imgfile.png" align="right" alt="" width="120" />

<!-- badges: start -->
`r badge_devel("fontikar/ohwhaley", "blue")`
`r badge_lifecycle("experimental", "orange")`
[![R-CMD-check](https://github.com/fontikar/ohwhaley/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/fontikar/ohwhaley/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/fontikar/ohwhaley/branch/master/graph/badge.svg)](https://app.codecov.io/gh/fontikar/ohwhaley?branch=master)
<!-- badges: end -->

Whale-come! This R package was inspired by [cowsay](https://github.com/sckott/cowsay) and [praise](https://github.com/rladies/praise). I hope this package made you smile today! 

## First things first

`ohwhaley` is a toy project and is still under development. You can install the latest version from [GitHub](https://github.com/) with:

```{r, install, results = "hide", eval = FALSE}
# install.packages("remotes")
remotes::install_github("fontikar/ohwhaley")
```

## Take it for a spin

`ohwhaley` contains one function only. `say()` will echo a randomly chosen whale-themed phrase for your enjoyment.

```{r example}
library(ohwhaley)
 
say() 
```

Alternatively, you can supply your own phrase

```{r, customise}
say("I'm beached as bro!!!")
```