The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

In-Code Documentation for ‘GAMS’

R package goxygen, version 1.0.3

Travis build status DOI codecov

Purpose and Functionality

A collection of tools which extract a model documentation from ‘GAMS’ code and comments. In order to use the package you need to install ‘pandoc’ and ‘pandoc-citeproc’ first (https://pandoc.org/).

Installation

For installation of the most recent package version an additional repository has to be added in R:

options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))

The additional repository can be made available permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).

After that the most recent version of the package can be installed using install.packages:

install.packages("goxygen")

Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):

update.packages()

Tutorial

The package comes with a vignette describing the basic functionality of the package and how to use it. You can load it with the following command (the package needs to be installed):

vignette("goxygen") # Creating GAMS model documentations with goxygen

Questions / Problems

In case of questions / problems please contact Jan Philipp Dietrich dietrich@pik-potsdam.de.

Citation

To cite package goxygen in publications use:

Dietrich J, Karstens K, Klein D, Baumstark L (2020). goxygen: In-Code Documentation for ‘GAMS’. doi: 10.5281/zenodo.1411404 (URL: https://doi.org/10.5281/zenodo.1411404), R package version 1.0.3, <URL: https://github.com/pik-piam/goxygen>.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {goxygen: In-Code Documentation for 'GAMS'},
 author = {Jan Philipp Dietrich and Kristine Karstens and David Klein and Lavinia Baumstark},
 year = {2020},
 note = {R package version 1.0.3},
 doi = {10.5281/zenodo.1411404},
 url = {https://github.com/pik-piam/goxygen},
}

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.