Skip to content

SciViews/svUnit

Repository files navigation

svUnit

R-CMD-check Win Build Status Coverage Status CRAN Status License Life cycle stable

{svUnit} is a testing framework inspired by {RUnit}, itself inspired by xUnit/jUnit. It is similar and compatible with {RUnit}, but implemented differently internally. Test suite written for {RUnit} or {svUInit} should be intercompatible. Look at the documentation to discover what {svUnit} offers for testing your R packages.

Installation

The latest stable version of {svUnit} can simply be installed from CRAN:

install.packages("svUnit")

You can also install the latest development version. Make sure you have the {remotes} R package installed:

install.packages("remotes")

Use install_github() to install the {svUnit} package from Github (source from master branch will be recompiled on your machine):

remotes::install_github("SciViews/svUnit")

R should install all required dependencies automatically, and then it should compile and install {svUnit}.

Latest devel version of {svUnit} (source + Windows binaries for the latest stable version of R at the time of compilation) is also available from appveyor.

Further explore {svUnit}

You can get further help about this package this way: Make the {svUnit} package available in your R session:

library("svUnit")

Get help about this package:

library(help = "svUnit")
help("svUnit-package")
vignette("svUnit") # None is installed with install_github()

For further instructions, please, refer to these help pages at https://www.sciviews.org/svUnit/.

Code of Conduct

Please note that the {svUnit} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Note to developers

This package used to be developed on R-Forge in the past. However, the latest R-Forge version was moved to this GitHub repository on 2016-03-17 (SVN version 569). Please, do not use R-Forge anymore for SciViews development, use this GitHub repository instead.