README.md 1.49 KB
Newer Older
Julien Veyssier's avatar
Julien Veyssier committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
R package checker
=================

# Introduction
---

R package checker is a tool to check if a new version of an R package (you might be developing) brakes any package which depends on it.

It works with a Bash script and an optional simple web interface. It runs R CMD CHECK on every package that depends on the package to test.

The execution of the R CMD CHECK can be parallelized by giving the corresponding option to the Bash script.

XVFB is used to perform graphical actions even without being under a running X server. JQuery is used to present check results.

There is basically three ways to use R package checker :

* Call the Bash script directly and watch the output
* Call the Bash script directly with the --html option to produce a real-time html output
* Setup the Php files and adapt values in config.php to manage test launch and results viewing.

## Table of content
---
1. [Screenshots](#screenshots)
2. [Requirements](#requirements)
3. [Usage](#installation)
    1. Direct Bash call
        * without --html
        * with --html
    2. With the basic web interface

# Screenshots
---
Bash script output :
![screenshot](https://gitlab.com/eneiluj/r-package-checker/raw/master/screenshots/screen.png)

# Requirements
---
* MANDATORY any version of R (results will be different from one version to another)
* MANDATORY Xvfb
* OPTIONAL Php enabled web server
* Java is probably needed by one of the packages depending on the package to check

# Usage
---
Adjust variables in config.php :

```php
```