README.md

kittyR: Kitty pictures and meows from R console

CRAN_Release_Badge Travis Build
Status AppVeyor Build
Status lifecycle Project Status: Active - The project has reached a stable, usable
state and is being actively
developed. Last-changedate GitHub code size in
bytes

This package is designed for rainy days when your results are heartbreaking or when no matter what you try, you can’t seem to get rid of that bug. Take a respite from those negative thoughts by accessing kitty pics and their adorable meows right from your R console 😻 and then get back to work again!

You can get the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("IndrajeetPatil/kittyR")

There are only two available functions in this package-

In case you want a picture of a kitty:

# to always have the same kitty on README
set.seed(100)

# show me the kitty NOW!
kittyR::kittyR()

By default, the collection will include any kind of cat (big, small, wild, etc.). If you want only kittens, you can use an additional argument.

# to always have the same kitty on README
set.seed(100)

# show me the kitten NOW!
kittyR::kittyR(meow = FALSE, only_kitten = TRUE)

The collection of cat pictures comes from the following collections of freely available images:

In case you just want to hear a meow either apropos nothing or at the end of execution of some code to let you know that the execution is complete, just include this line of code:

# can't print the sound, so
# meow meow meow
# you can choose from a sample of sounds included in the package
kittyR::meowR(sound = 4)

If you have a kitty meow that you like and would like to include in the package, please either make a PR or e-mail it to me and I will include it.

This package was inspired by pupR package by Melissa Innerst. Thanks are due to my lab buddy Jonathan Phillips for suggesting including meowR function as a replacement for beepR.

May these kitties bring some joy and amusement during your stressful data digging jobs!



IndrajeetPatil/kittyR documentation built on June 12, 2019, 7:34 a.m.