Commit 30b14ac3 authored by Jean-Francois Rey's avatar Jean-Francois Rey

update readme

parent 927cb0bc
Pipeline #797 canceled with stages
in 20 seconds
......@@ -5,7 +5,7 @@ Title: R Template Package
Version: 0.1.0
Date: 2019-11-05
Authors@R: person("Jean-Francois", "Rey", role = c("aut","cre"), email = "jean-francois.rey@inra.fr")
Author: Jean-Francois Rey [cre, aut]
Author: Jean-Francois Rey [aut, aut]
Maintainer: Jean-Francois Rey <jean-francois.rey@inra.fr>
Description: A R package template to manage the package and the CI/CD pipeline.
URL: https://gitlab.paca.inra.fr/r-ecosystem/cookbooks/r-packages-ci-cd
......
......@@ -4,9 +4,9 @@ This project hosts the repository of a Cookbook to manage a R package.
This template generate the documentation, build the package, run unit tests, check --as--cran, create package binaries for Windows and Mac OS...
[useR2019 poster __R package development using GitLab CI/CD pipeline__ , JF Rey, L Houde, 2019](inst/userR2019-poster_JF_REY.pdf)
## A quick look at that : [useR2019 poster __R package development using GitLab CI/CD pipeline__ , JF Rey, L Houde, 2019](inst/userR2019-poster_JF_REY.pdf)
** Table of Contents**
## Table of Contents
- [Prerequisites](#prerequisites)
- [Files](#files)
......@@ -20,11 +20,12 @@ This template generate the documentation, build the package, run unit tests, che
## Prerequisites
* Have to know:
* Have to know:
* GitLab project management
* R Packages
* R Packages
* Should to know:
* Should to know:
* GitLab Runners principle
* GitLab CI/CD principle
* R Package CRAN policy
......@@ -33,8 +34,8 @@ This template generate the documentation, build the package, run unit tests, che
There are severals version of this project, depending if the package need compilations, vignettes... :
* simple R package : [master](tree/master)
* R package and c++ code source : [Rcpp](tree/rcpp)
* simple R package : [master](/master)
* R package and c++ code source : [Rcpp](/rcpp)
## Files
......@@ -73,10 +74,15 @@ and enable __Shared Runners__ (_Setting -> CI/CD -> Runners_).
### The runners
Four Runners are availables for R Packaging in the shared runners :
* r-base-biosp : it's the current version of R for Linux OS (nightly build as docker image). [See here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images) for more information.
* r-devel-biosp : it's the in development version of R (the next version) for Linux OS (nightly build as docker image). [See here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images) for more information.
* R win10 binaries : a Windows 10 Virtual Machine with the current R and Rtools version.
* R Mac : a Mac OS High Sierra with the current R and Rtools version.
* __r-base-biosp__ : it's the current version of R for Linux OS (nightly build as docker image). [See here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images) for more information.
* __r-devel-biosp__ : it's the in development version of R (the next version) for Linux OS (nightly build as docker image). [See here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images) for more information.
* __R win10 binaries__ : a Windows 10 Virtual Machine with the current R and Rtools version.
* __R Mac__ : a Mac OS High Sierra with the current R and Rtools version.
Check _tags_ in [.gilab-ci.yml](.gitlab-ci.yml) file to enable the runner needed.
This runners come with pre-installer R packages, R tools and system-libraries (bin and dev).
See [here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images/blob/master/r-base-biosp/Dockerfile) for more informations.
If you need you can add your own runner or ask GitLab administrator to set up a new one.
......@@ -92,7 +98,7 @@ It set up three stages (create, tests and build) and severals jobs by stages.
You need to set up this file for your project.
Each jobs produces artifacts mainly in _build_ stage it produces R packages delivery for Linux, Windows and Mac OS.
Each jobs produce artifacts mainly in _build_ stage, they produce R packages delivery for Linux, Windows and Mac OS.
## Author
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment