In BenjaminLouis/benutils: Help for R package development

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

benutils

The goal of benutils is to ...

Installation

You can install the released version of benutils from CRAN with:

install.packages("benutils")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("BenjaminLouis/benutils")

Example

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

library(benutils)
## basic example code

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.

Code of Conduct

Please note that the benutils project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

BenjaminLouis/benutils documentation built on Jan. 25, 2021, 6:12 a.m.