In lgarreta/toypackage: A toy package

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

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")
greetings (c("Alice", "Bob"))

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

summary(cars)

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:

plot(pressure)

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.