Skip to content

Commit

Permalink
- updated authors and increased model version to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tscheypidi committed Jun 26, 2020
1 parent 26c0ef9 commit 5aed7f8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
8 changes: 7 additions & 1 deletion .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
{
"title": "goxygen: In-Code documentation for GAMS",
"version": "0.39.6",
"version": "1.0.0",
"description": "<p>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/).<\/p>",
"creators": [
{
"name": "Dietrich, Jan Philipp"
},
{
"name": "Karstens, Kristine"
},
{
"name": "Klein, David"
},
{
"name": "Baumstark, Lavinia"
}
]
}
8 changes: 5 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Package: goxygen
Type: Package
Title: In-Code documentation for GAMS
Version: 0.39.6
Version: 1.0.0
Date: 2020-06-26
Authors@R: c(person("Jan Philipp", "Dietrich", email = "[email protected]", role = c("aut","cre")),
person("Kristine", "Karstens", email = "[email protected]", role = "aut"))
person("Kristine", "Karstens", email = "[email protected]", role = "aut"),
person("David", "Klein", email = "[email protected]", role = "aut"),
person("Lavinia", "Baumstark", email = "[email protected]", role = "aut"))
Description: 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/).
Imports: pander, stringi, gms, citation, yaml
URL: https://github.com/pik-piam/goxygen, https://doi.org/10.5281/zenodo.1411404
Expand All @@ -17,4 +19,4 @@ Suggests: testthat,
knitr,
rmarkdown
VignetteBuilder: knitr
ValidationKey: 7301844
ValidationKey: 1843900
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# In-Code documentation for GAMS

R package **goxygen**, version **0.39.6**
R package **goxygen**, version **1.0.0**

[![Travis build status](https://travis-ci.com/pik-piam/goxygen.svg?branch=master)](https://travis-ci.com/pik-piam/goxygen) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1411404.svg)](https://doi.org/10.5281/zenodo.1411404) [![codecov](https://codecov.io/gh/pik-piam/goxygen/branch/master/graph/badge.svg)](https://codecov.io/gh/pik-piam/goxygen)

Expand Down Expand Up @@ -35,7 +35,7 @@ update.packages()
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):

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

## Questions / Problems
Expand All @@ -46,18 +46,18 @@ In case of questions / problems please contact Jan Philipp Dietrich <dietrich@pi

To cite package **goxygen** in publications use:

Dietrich J, Karstens K (2020). _goxygen: In-Code documentation for GAMS_. doi:
10.5281/zenodo.1411404 (URL: https://doi.org/10.5281/zenodo.1411404), R package
version 0.39.6, <URL: https://github.com/pik-piam/goxygen>.
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.0, <URL:
https://github.com/pik-piam/goxygen>.

A BibTeX entry for LaTeX users is

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

0 comments on commit 5aed7f8

Please sign in to comment.