README.md

In paritoshkroy/rpkg: My First Package in R

rpkg

The goal of rpkg is to …

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("paritoshkroy/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)
#>      speed           dist       
#>  Min.   : 4.0   Min.   :  2.00  
#>  1st Qu.:12.0   1st Qu.: 26.00  
#>  Median :15.0   Median : 36.00  
#>  Mean   :15.4   Mean   : 42.98  
#>  3rd Qu.:19.0   3rd Qu.: 56.00  
#>  Max.   :25.0   Max.   :120.00
mean(cars$speed)
#> [1] 15.4
sd(cars$speed)
#> [1] 5.287644

You’ll still need to render README.Rmd regularly, to keep README.md up-to-date.

You can also embed plots, for example:

In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub!

paritoshkroy/rpkg documentation built on May 28, 2019, 12:34 a.m.