penguinclassify

The goal of penguinclassify is to …

Installation

You can install the development version of penguinclassify from GitHub with:

# install.packages("devtools")
devtools::install_github("DSCI-310/2023-03-16-penguinclassify")

Example

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

library(penguinclassify)

classify_penguin(100, 50)
#> [1] "Chinstrap"

What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

summary(cars)
#>      speed           dist       
#>  Min.   : 4.0   Min.   :  2.00  
#>  1st Qu.:12.0   1st Qu.: 26.00  
#>  Median :15.0   Median : 36.00  
#>  Mean   :15.4   Mean   : 42.98  
#>  3rd Qu.:19.0   3rd Qu.: 56.00  
#>  Max.   :25.0   Max.   :120.00

You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.