/threePGN-package

3PGN model in fortran called from R

Primary LanguageFortran

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. License: GPL v3

threePGN

An R package to run the 3PGN model written in fortran.

Installing the development version from GitHub

If you want to install our development version from GitHub, use

devtools::install_github(repo = "checcomi/threePGN-package/r3pg", dependencies = T, build_vignettes = T)

Build Status

New developments will be done in extra branches and will be tested before merging in the developtment branch, so the developmet version should usually be usable (consider it in a beta stage), while feature branches should be considered alpha.

Windows users: the package contains c++ code, so if you compile yourself, you need RTools installed.

Working with the package

To get an overview about its functionality once the package is installed, run

library(threePGN)
?threePGN
vignette("threePGN", package="threePGN")

As for every R package, you can get the suggested citation via

citation("threePGN")