README.md

In phgrosjean/R-code: Experimental R Code by Philippe Grosjean

R-code (PhGcode R package)

This is a collection of experimental R code I develop mainly for myself.

NOTE: Since it is GPL-licensed, feel free to use what you find useful (but don't forget to cite the source!)...

Package homepage for details and examples.

Installation

You cannot install this package from CRAN, because it is only intended for experimental code!

You can install from Github:

## If you don't have devtools yet
install.packages("devtools")
## Install PhGcode from Github
devtools::install_github("phgrosjean/R-code")

If you know GIT and R CMD build, here is another way:

git clone https://github.com/phgrosjean/R-code.git
R CMD build PhGcode
R CMD INSTALL PhGcode_*.tar.gz

Latest devel version also available in sources and Windows binaries at appveyor.

Motivation

I need a test package for my new ideas in R.

Usage

install("PhGcode")
?PhGcode

Contributing

For fixing typos or other very simple changes, just edit the file (click Edit when on the Github web site).

For more changes, create a pull request after forking the repository.

Use test units to make sure you don't break anything with your changes. PhGcode uses the svUnit package. If you added any features, add your own tests in inst/unitTests/.

To launch the tests, from the root directory containing your source code, you can perform an R CMD check during the build/check phase:

R CMD build R-code; R CMD check PhGcode_*.tar.gz

If you do not understand this, just forget about it. Look at the bagdes that appear on top of the README.md file to know if the process succeeded or not last time it was run automatically using travis-CI for Linux and OS X and appveyor for Windows.

License

This package is free and open source software, licensed under GPL.

phgrosjean/R-code documentation built on May 25, 2019, 2:55 a.m.