In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

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

{{{ Package }}}

  

The goal of {{{ Package }}} is to ...

Installation

You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("inbo/{{{ Package }}}")

Example

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

library({{{ Package }}})
## 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 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.

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.