In peck-AU/testpackageTest: My Package as a Demo Package

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

testpackageTest

The goal of testpackageTest is to evaluate our functions ...

Installation

You can install the released version of testpackageTest by asking me

install.packages("testpackageTest")

Example

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

library(testpackageTest)
## 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.

peck-AU/testpackageTest documentation built on Feb. 22, 2021, 4:04 a.m.