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

mypackage

The goal of mypackage is to print a personalised message

Installation

You can install the deveolpment version of mypackage from GitHub with:

devtools::install_github("meganholgate/mypackage")

Example

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

library(mypackage)
## basic example code
hello()

hello(name= "Meg")

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!



meganholgate/mypackage documentation built on May 8, 2019, 7:40 a.m.