In MattPM/test:

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

test

The goal of test is to ... Test the R package I'm trying to build.

Installation

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

install.packages("test")

Example

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

library(test)
suppressMessages(library(tidyverse))
## basic example code
normalized_mtx = test::MyScaleFunction(df = df) %>% as.data.frame()
ggplot(normalized_mtx, aes(x = x, y = y)) + geom_bin2d()

What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

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!

MattPM/test documentation built on Jan. 20, 2020, 12:04 a.m.