In jponmattam/testR: Tests New R Packages

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

testR

The goal of testR is to provide functionality for my package.

Installation

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

install.packages("testR")

Example

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

library(testR)
## basic example code
hello('Jon')

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.

jponmattam/testR documentation built on Dec. 21, 2021, 3:13 a.m.