README.md

In cemreyilmaz/tester: Tests R Packages

tester

The goal of tester is to test how to create a package in R. These functions are for educational purpose and for use only with Cemre Yilmaz and no other people.

Installation

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

install.packages("tester")

Example

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

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

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:

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

cemreyilmaz/tester documentation built on Dec. 19, 2021, 2:54 p.m.