README.md

In lgarreta/toypackage: A toy package

toypackage

The goal of toypackage is to provide an example of how to create R packages.

Installation

You can install the development version of toypackage from Github with:

install.packages("toypackage")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("lgarreta/toypackage")

Example

This is a basic example of the functions in the package:

library(toypackage)
## basic example code
hello ("Alice")
#> [1] "Hello Alice!"
greetings (c("Alice", "Bob"))
#> [1] "Greetings Alice." "Greetings Bob."

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/master/examples.

You can also embed plots, for example:

In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

lgarreta/toypackage documentation built on Dec. 21, 2021, 10:44 a.m.