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

samplepackage

Travis build status

The goal of samplepackage is to ...

Installation

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

install.packages("samplepackage")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("KoderKow/samplepackage")

Example

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

library(samplepackage)
## 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!



KoderKow/samplepackage documentation built on June 17, 2019, 12:02 a.m.