fRiend exports one function: greeting_octopus()
. This generates an
ASCII art octopus with randomized facial expressions and coloring,
cat()
-ing it to the console:
The main use-case of greeting_octopus()
is including it in your
.Rprofile
so that it is
executed each time you start up an R session. I recommend wrapping it in
if (interactive()) { ... }
, like this:
if (interactive()) {
fRiend::greeting_octopus()
}
Generally, your .Rprofile
should be located in your home
directory. If you have
usethis installed, you can edit it
with usethis::edit_r_profile()
.
You can install the fRiend package from GitHub with:
# install.packages("remotes")
remotes::install_github("jamesotto852/fRiend")
Here are a few examples of the different kinds of octopodes you can get
from greeting_octopus()
:
Finally, note that greeting_octopus()
is customizible. If you’re not
feeling the angry eyes, you can disable them by setting
include_angry = FALSE
. Also, if you’d rather draw from a different
color pallet you can provide an alternative list of functions from
crayon to color_funs
: