In SaraZM/rpkg: What the Package Does (One Line, Title Case)

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

rpkg

The goal of rpkg is to do nothing.

Installation

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

install.packages("rpkg")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("SaraZM/rpkg")

Example

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

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

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!

SaraZM/rpkg documentation built on May 28, 2019, 12:31 a.m.